Visit api.envoke.com to test APIs and get examples in 20+ languages
id
Type: Integer
Length: 4 bytes (max: 4294967295)
The Envoke message ID.
IMPORTANT: the "id" field is only used for adding recipients to an existing message. For most requests to the /send API, do not provide an "id". The "id" of the newly created message will be returned in the response data.
If the "id" field is provided, no other fields are allowed except for "recipients".
name
Type: String
Length: 100 (max)
The message name. Displayed in the messages list in the Envoke UI and in reports. Minimum length 3 characters.
subject
Type: String
Length: 120 (max)
The message subject line. Minimum length 6 characters.
group
Type: String or Integer
The folder where the message will be displayed in the Envoke UI messages list. Not required; by default messages will not be grouped and will appear in the "All" section of the messages list.
Either the folder ID or name may be provided to update this value.
sender
Type: String or Integer
Either the sender ID or value may be provided to update this value.
If providing the value, senders must be in the following format:
FIRST_NAME LAST_NAME <EMAIL_ADDRESS>
For example: John Doe <example@envoke.com>
language
Type: String
Length: 2 characters
Envoke supports the following language codes with full translations on the "consent & subscription preferences" page.
"en" = English
"fr" = French
track_recipient_activity
Type: Boolean
Enable open and click tracking for the message. Defaults to false.
NOTE: enabling this feature will result in slower sending. If you require the highest level of sending speed, do not set this field = true.
enable_merge_fields
Type: Boolean
Enable merge fields for the message. Defaults to false.
IMPORTANT: even when set to false, the preferences page merge field "{@pref-0}" will always be replaced.
NOTE: enabling this feature will result in slower sending. If you require the highest level of sending speed, do not set this field = true.
recipients
Type: Array
The "recipients" field may be an array of email addresses, or an array of objects with an "email" property.
html
Type: String
The HTML for the message.
Only one of the fields "html" and "template_id" may be provided when creating a new message.
template_id
Type: Integer
The ID of an existing message or template to be used as the HTML for the new message.
Only one of the fields "html" and "template_id" may be provided when creating a new message.
Envoke Send Object
{
"name": "API example message",
"group": "",
"sender": "API example <noreply@envoke.com>",
"subject": "Sending API example!",
"language": "en",
"recipients": [ "api-example@test.com", "api-example2@test.com" ]
}