Waitlist API reference

Waitlist API · Waitlist-Settings

post/v1/workspaces/{workspace_id}/waitlist/settings/notifications/{slot}/testAuth

Send me a test of one Waitlist email

Sends the slot's real Mail template, with the workspace's real Waitlist sender (the workspace default or the custom address) and example values, to your own verified account address. It cannot be sent anywhere else. It uses your own Mail access, goes through the same send path as real emails, and shows up in Mail > Emails. At most 10 tests per person per hour. Not available to API keys (a key has no inbox).

Path parameters

workspace_id*string · uuid

Id of the workspace.

slot*enum (3)

The email to test.

Headers

Idempotency-Keystring

Stripe-style idempotency key. A retried request with the same key returns the first response instead of sending a second email. 24h TTL.

Response · 202 Accepted by Mail and queued for delivery.

to*string · email

Your own verified account address: tests only ever go to the person who asked.

Example: "you@acme.com"

template_name*string

The Mail template that was sent.

Example: "waitlist-welcome"

from*string

The From it went out with.

Example: "Acme <hello@acme.com>"

message_id*string · uuid

The Mail message id; look it up in Mail > Emails to follow delivery.

Example: "0d6c1c3e-5f2a-4b8e-9d17-3a4b5c6d7e8f"

Example

Request

POST https://api.waitlist.productcraft.co/v1/workspaces/{workspace_id}/waitlist/settings/notifications/{slot}/test
Authorization: Bearer YOUR_TOKEN

Response

{
  "to": "you@acme.com",
  "template_name": "waitlist-welcome",
  "from": "Acme <hello@acme.com>",
  "message_id": "0d6c1c3e-5f2a-4b8e-9d17-3a4b5c6d7e8f"
}