EmailPayload

EmailPayload contains fields to form email messages to recipients and is used in send endpoints.

Type

Object

Fields

Field name

Type

Writable

Required

Description

subject

string

The subject of the email.

sender

string

The sender of the email. Will be used as the email's reply-to address. Must be a valid email address.

recipients

array of string

An array of recipients of this email. Must all be valid email addresses.

message

string

Additional message for the recipients besides the system default text. Allows HTML format. Must not exceed 255 characters.

ccToSender

boolean

true to send a duplicate to the address in the sender field.

Sample

{
"subject": "Urgent: invoice for your reference.",
"sender": "demo@pymlo.com",
"recipients": ["customer@acme.org", "boss@acme.org"],
"message": "Hi<br/>Please make the payment as instructed on the invoice.",
"ccToSender": false
}