Skip to main content
POST
cURL
Guide: Schedule one email yourself. Errors: Errors and limits.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
transactional
string
required

Template uid (7 characters). uid works too.

Example:

"TRF4MS9"

recipient
string
required

Email address of the recipient.

Example:

"guest@example.com"

customFields
object

Values for the template's merge fields, such as {GUEST_NAME}. Keys are turned to capitals. Other top-level keys you send are used as merge fields too.

Example:
tenant
string

The restaurant this email is for. Stored on the message for statistics and billing.

Maximum string length: 64
Example:

"restaurant_4812"

senderId
integer

A sender id from List Senders. Its domain must be verified.

Example:

34

from
string

"Name <address>" or an address under a verified domain of your workspace.

Example:

"Trattoria da Mario <bookings@yoursaas.example>"

fromAddress
string

Same as from, address only. At most one of senderId, from, fromAddress.

fromName
string

Display name of the sender.

replyTo
string

Where replies go. Any mailbox. A malformed value answers 422 INVALID_REPLY_TO.

Maximum string length: 320
Example:

"owner@trattoriadamario.example"

sendAt
string

Schedule the email: ISO 8601 with the UTC offset, in the future, at most 90 days ahead. Not for sign-in, verification or one-time-code emails.

Example:

"2026-11-19T20:30:00+01:00"

idempotencyKey
string

With sendAt: the same key again returns the email already scheduled (duplicate: true).

Example:

"booking-4812-reminder"

cancellationKey
string

With sendAt: groups emails you may cancel together with Cancel Scheduled Emails.

Example:

"booking-4812"

Response

Sent (status: 200) or scheduled (status: 202). sent: 0 with a reason means nothing was sent (for example no subject, or no marketing consent).

data
object