Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
from
string | null

Sender email address (uses account default if omitted)

to
string[]

List of recipient email addresses

subject
string

Email subject line

body
string

Email body content

customer_type
string | null

Filter recipients by customer type

send_to_all
boolean | null

Send to all customers

Response

Email queued

object
enum<string>
required
Available options:
email
recipients
integer
required

Number of recipients

subject
string
required
status
enum<string>
required
Available options:
queued