Skip to main content
POST
Generate Emails

Authorizations

api_key
string
header
required

Headers

x-request-source
string

Optional header used to identify the source of the request. Helps us apply appropriate rate limiting or disable it when necessary.

Example:

"some-source"

x-external-request-id
string

External Request ID. Add this header to identify the request from the client for better tracking and debugging.

Example:

"external-request-id"

Body

application/json
sequence
object
required
offering
object
required
recipient
object
required
callbackUrl
string<uri>
required

Callback URL

Example:

"https://example.com/api/callbacks/unique-id"

Response

Async request accepted

status
enum<string>
required

Status

Available options:
pending,
completed,
failed
Example:

"pending"

requestId
string
required

Request ID

Example:

"requestId"

message
string | null

Message

Example:

"Additional information"