OpenAPI.RequestBody

Preview

Body

application/jsonoptional

fromstringrequired

Sender email address. To include a friendly name, use the format "Your Name <sender@domain.com>".

tostring | string[]required

Recipient email address. For multiple addresses, send as an array of strings. Max 50.

subjectstringrequired

Email subject.

bccstring | string[]

Bcc recipient email address. For multiple addresses, send as an array of strings.

ccstring | string[]

Cc recipient email address. For multiple addresses, send as an array of strings.

reply_tostring | string[]

Reply-to email address. For multiple addresses, send as an array of strings.

htmlstring

The HTML version of the message.

textstring

The plain text version of the message.

templateobject

headersobject

Custom headers to add to the email.

scheduled_atstring

Schedule email to be sent later. The date should be in ISO 8601 format.

attachmentsAttachment[]

tagsTag[]

topic_idstring

The topic ID to scope the email to. If the recipient is a contact and opted-in to the topic, the email is sent. If opted-out, the email is not sent. If the recipient is not a contact, the email is sent if the topic's default subscription is opt_in.

<OpenAPI.Operation id="emails-send">
  <OpenAPI.RequestBody />
</OpenAPI.Operation>

Fields that hold objects or lists can be expanded. If the body accepts more than one content type, a menu switches between them. Read-only fields are hidden, since clients don't send them.

You can also pass a body directly: <OpenAPI.RequestBody requestBody={operation.requestBody} />.