Skip to content

Send a transactional email

POST
/transactional/send
idempotency-key
required
string

Client-generated key; a retry with the same key returns the original receipt.

object
campaign_id
required
string
email
required
string format: email
template_data
object
key
additional properties
any
object
message_id
string
reason
string
scheduled_at
string format: date-time
status
required
string

Invalid_request

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

Invalid_credential

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

Insufficient_scope

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

Not_found

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

Conflict

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

Validation_failed

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

Rate_limited

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

Internal_error

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string