Send one announcement email to the waitlist

POST

/v1/waitlist/announcements

The “we are live” email: one plain-text message to the people on the waitlist. Not a campaign tool: one announcement per project in any 24 hours, never to anyone who unsubscribed, always with the one-click unsubscribe link. {{project_name}} and {{link}} are filled in per person; {{link}} is the waitlist’s welcome_url when set, otherwise the person’s hosted welcome page. Send dry_run: true first: it returns the recipient count and a rendered preview and sends nothing. Sending is queued and shares the platform’s daily email limit, so a large list can take a while; the response is 202.

Auth: Secret key only. Indie and up.

Authorizations

• SecretApiKey

Request Body ^required

object

subject

required

string

<= 150 characters

body

required

Plain text.

string

<= 5000 characters

audience

string

default: waiting

Allowed values: waiting invited all

dry_run

boolean

Responses

200

Dry run: recipients and preview

202

Queued

401

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

403

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

429

WAITLIST_ANNOUNCEMENT_TOO_SOON

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties