In order to send an Email message, you must have an active Email channel and perform a HTTP request to the following endpoint with a
Examples:
Send a plain text email
To send a plain text email message with the above endpoint set the request body as follows:
Copy 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": "text",
"text": {
"text": "Single text message"
}
}
}' Send an html email
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.
Copy 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
Copy curl --location '/workspaces/:workspaceID/channels/:channelID/messages' \
--header 'Content-Type: application/json' \
--header 'Authorization: ' \
--data-raw '{
"receiver": {
"contacts": [
{
"identifierKey" : "emailaddress",
"identifierValue": "user1@example.com"
},
{
"identifierKey" : "emailaddress",
"identifierValue": "user2@example.com"
},
{
"identifierKey" : "emailaddress",
"identifierValue": "user3@example.com"
}
]
},
"body": {
"type": "html",
"html": {
"html": "<div><h1>Hey, this is a nice html email to multiple recipients.</h1></div>"
}
}
}' Within the HTML body object you can include a metdata object as follows:
body.metadata.html.subject = set the email subject
body.metadata.emailfrom.username = set the sender before the @ e.g. support
body.metadata.emailfrom.displayname = set the display name appearing in users inbox e.g. Support team
body.metadata.headers.reply-to = the reply-to address
Set the email subject
Copy 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": "text",
"text": {
"text": "Hey, this is a nice text email.",
"metadata": {
"subject": "What is the subject?"
}
}
}
}' Send a html message with attachments
Add attachment objects to body.text.attachments[] or body.html.attachments[] as shown. Each attachment object has the following properties:
mediaUrl = The URL location of the media
filename = The name of the file
inline = boolean (default false).
Copy 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": "text",
"text": {
"text": "Hey, this is a nice text email.",
"attachments": [
{
"mediaUrl": "https://docs.bird.com/~gitbook/image?url=https%3A%2F%2F3210271997-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FdnJZeZvhOMhDQA8SpjQM%252Flogo%252FDR12k6Q9swjRC5qGPMFM%252FFrame%252071487.png%3Falt%3Dmedia%26token%3D81a28146-ce23-466b-84b2-3eca81168d86&width=128&dpr=3&quality=100&sign=d231cba2&sv=1",
"filename": "bird.png"
}
]
}
}
}' Send an html message with inline images
Add an array of attachments to body.html as above, but set body.html.attachments[].inline to true.
Within body.html reference the image in an image tag and prefix the filename with cid:
For example:
Copy <img src="cid:imagetext.png">
Copy 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": {
"text": "Single text message",
"html": "<p style=\"\">Single html message</p><p style=\"\"></p><p style=\"\"><p>INLINE IMAGE! <img src=\"cid:image.png\"></p>",
"metadata": {
"subject": "Here is an Email with an attachment",
"headers": {
"reply-to": "replyto@this.address"
},
"emailFrom": {
"username": "support",
"displayName": "Support Team"
}
},
"attachments": [
{
"mediaUrl": "mediaurl",
"filename": "image.png",
"inline": true
}
]
}
}
}' Send a message with a template
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.
For example:
Copy curl --location '/workspaces/:workspaceID/channels/:channelID/messages' \
--header 'Content-Type: application/json' \
--header 'Authorization: ' \
--data-raw '{
"receiver": {
"contacts": [
{
"identifierKey" : "emailaddress",
"identifierValue": "user@example.com"
}
]
},
"template": {
"locale": "en",
"projectId": ":projectID",
"version": ":versionID",
"attachments": [
{
"mediaUrl": "https://api.bird.com/bird.png",
"filename": "bird.png"
}
]
}
}' Send a message specifying the use case
The example describes the request body to send an email with custom use case types. The default type is marketing, but you can specify others listed.
Copy 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": "text",
"text": {
"text": "Hey, this is a nice text email."
}
},
"meta": {
"extraInformation": {
"useCase": "transactional"
}
}
}' This example describes the request body to send an email with tags.
Copy curl --location '/workspaces/:workspaceID/channels/:channelID/messages' \
--header 'Content-Type: application/json' \
--header 'Authorization: ' \
--data-raw '{
"receiver": {
"contacts": [
{
"id": ":contactID"
}
]
},
"body": {
"type": "text",
"text": {
"text": "Hey, this is a nice text email."
}
},
"tags": ["tag-1", "tag-2"]
}' 
