To send an html email message with the above endpoint, set the request body as follows.
For email clients that do not support html and rich content set the plain text fallback field.
curl--location'/workspaces/:workspaceID/channels/:channelID/messages' \--header 'Content-Type: application/json' \--header 'Authorization: ' \--data-raw '{ "receiver": { "contacts": [ { "identifierKey" : "emailaddress", "identifierValue": "user@example.com" } ] }, "body": { "type": "html", "html": { "html": "<div><h1>Hey, this is a nice html email.</h1></div>" } }}'
Send an email to multiple participants
To send an email to multiple participants, add another object to the contacts array. Use the type field to specify if the recipient of the email should be on the To list, in CC, or BCC
Using Studio, you can create templates that can be reused across multiple email messages.
To use a template in a message:
First make sure that the template is active.
Then, specify the template details in the template field of the request body, including the projectId, version, locale, and any variables that are present in the template.
Make sure that the variable names in your request match the variable names in the created template.
You can also add attachments to your template messages by adding an attachment array.
A reference to the message. This can be used to identify the message in the channel.
Example: "my-own-identifier"
templatenullable Template (object)
metaMeta (object)
replyToReplyTo (object)
bodyMessageBody
notificationChannelNotification
capFrequencyboolean
If set to true, the frequency capping settings of the platform will be used
to either allow or reject the message to a contact. Can only be set to true
if the message is sent to a contact and .meta.extraInformation.useCase is marketing.
enableLinkTrackingboolean
If set to true and message is a test/campaign message, web tracking parameters will be appended to the links in the message.
ignoreQuietHoursboolean
If set to true, quiet hours settings will be ignored and the message will be sent as soon as possible.
ignoreGlobalHoldoutboolean
Do not check if the recipient is part of global holdout. To be used to send transactional messages.
tagsTags (array of Name-3 (string))
Tags to associate with the message. Tags are converted to lower case and tags
that do not exist are automatically created. You can view your created tags
in the UI. You can specify up to 10 tags per message.
shortLinksnullable ShortLinks (object)
SMS link shortening options. When using templates, please refer to
the template level shortLinks instead.
scheduledForScheduledFor (string (date-time))
Scheduled time to send message at. Must be formated as RFC3339 timestamp. When
set, the message status will be scheduled until it's sent. Messages scheduled
for a time in the past or within 10 minutes of the request may be sent
immediately. Messages scheduled farther than 35 days will be rejected.
validityValidity (integer)
Validity determines for how many seconds a message is valid. If none is provided, the channel message type will be used to determine it.
A promotional, conversational or transactional channel message is valid for 36 hours (129600 seconds). A message sent from a 2FA channel is valid for 10 minutes (600 seconds).
any of
Response
Message was accepted for processing
Body
id*Id-2 (string (uuid))
channelId*ChannelId (string (uuid))
sender*one of
receiver*one of
metaMeta (object)
referenceReference (string)
A reference to the message. This can be used to identify the message in the channel.
This field is used to store additional information related to the message status.
failurenullable Failure (object)
tagsTags (array of Name-3 (string))
Tags to associate with the message. Tags are converted to lower case and tags
that do not exist are automatically created. You can view your created tags
in the UI. You can specify up to 10 tags per message.
shortLinksnullable ShortLinks (object)
SMS link shortening options. When using templates, please refer to
the template level shortLinks instead.
scheduledForScheduledFor (string (date-time))
Scheduled time to send message at. Must be formated as RFC3339 timestamp. When
set, the message status will be scheduled until it's sent. Messages scheduled
for a time in the past or within 10 minutes of the request may be sent
immediately. Messages scheduled farther than 35 days will be rejected.