Skip to main content
POST
Bulk Create Emails

Authorizations

Authorization
string
header
required

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

Body

application/json
email_sender
string
required

The EmailSender identifier, (e.g. sndr_abc123).

email_template
string
required

The EmailTemplate identifier, (e.g. eml_tmpl_abc123).

partners
string[]
required
Minimum array length: 1

The Partner identifier, (e.g. ptn_abc123).

auto_send
boolean

Response

Successful response

object
string
required
id
string
Maximum string length: 32
auto_send
boolean

Whether to automatically send the emails created by this bulk email request.When false, the emails will be created and left in a draft state for you to send.Defaults to false.

created_at
string<date-time>
email_sender_id
string | null
Maximum string length: 32
modified_at
string<date-time> | null
partner
object
requested_by
object
requested_by_id
string | null