Skip to main content
POST
Send an email template to a single person as a one-off email.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Path Parameters

templateUid
string | null
required

The Uid of the email template to send.

Body

application/json

The recipient and the optional from address and subject overrides.

PersonUid
string | null

The Uid of the person to send the email to. Required.

FromEmail
string | null

The from address. Defaults to the support email address for the account.

FromName
string | null

The from name. Defaults to the company name.

Subject
string | null

Overrides the subject of the template.

Response

Created
string<date-time>
required
read-only
Minimum string length: 1
Updated
string<date-time>
required
read-only
Minimum string length: 1
Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
Template
object | null
Recipient
object | null
Example:
UniqueMessageId
string | null
Maximum string length: 50
Subject
string | null
Maximum string length: 1000
FromEmail
string | null
Maximum string length: 250
FromName
string | null
Maximum string length: 250
SendDateTime
string<date-time>
ProcessDateTime
string<date-time> | null
DeliverDateTime
string<date-time> | null
BounceDateTime
string<date-time> | null
SpamDateTime
string<date-time> | null
OpenDateTime
string<date-time> | null
ClickDateTime
string<date-time> | null
UnsubscribeDateTime
string<date-time> | null
SendError
string | null