Send an email
Send an email from a provisioned address to a customer, owner, or raw email address.
Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
The email subject. On a thread reply, reuse the existing subject (prefix Re: if it is not already there). Never put this in body.
1 - 998The plain-text message body (greeting, content, sign-off). Do not start with "Subject:" — that belongs in subject.
1 - 20000The provisioned email address to send from (id or full address). Defaults to the account’s agent address when omitted.
The recipient email address. Required when customer and owner are not set.
Send to this customer’s email address.
Send to this owner’s email address.
The email template. plain sends a text-only email. branded wraps the body in the account’s branded HTML template (logo, colours, support details). Defaults to plain. Prefer branded for standalone official outbound; keep plain for thread replies.
plain, branded Optional CC recipients.
Optional Reply-To address. Defaults to the From address.
The Inbox thread to reply on. Required when drafting a reply — this is how the draft can be placed in the Inbox composer. Sets In-Reply-To / References from the last inbound message.
Optional file attachments.
Response
Returns the message object if the send succeeded.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
message The principal that sent this message. Set for outbound messages; null for inbound messages and for messages recorded before actor attribution existed.
Plain-text body, common to all channels.
The communication channel for this thread. email today; additional channels may be added later.
email Whether the message was sent by the account or received from a counterparty.
inbound, outbound The thread this message belongs to.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Email-specific fields. Present when channel is email.