Please note that this feature is available as a paid add-on only.
This method will create Transaction Email object, which will result in sending the transactional email to specified recipients.
Returns status code
201
Example Request Body
{
"fromField": {
"fromFieldId": "V"
},
"replyTo": {
"fromFieldId": "V"
},
"subject": "Order Confirmation - Example Shop",
"tag": {
"tagId": "vBd5"
},
"content": {
"plain": "Your order has been confirmed. Thank you for shopping with us!",
"html": "<h1>Your order has been confirmed</h1><strong>Thank you for shopping with us!</strong>"
},
"recipients": {
"to": {
"email": "john.doe@example.com",
"name": "John Doe",
"validSince": "2018-05-02T09:30:43+0200"
},
"cc": [
{
"email": "john.doe@example.com",
"name": "John Doe"
}
],
"bcc": [
{
"email": "john.doe@example.com",
"name": "John Doe"
}
]
},
"attachments": [
{
"fileName": "pixel.png",
"mimeType": "image/png",
"content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mOUua1dDwAD4AGjnrXmUAAAAABJRU5ErkJggg=="
}
]
}
Body params
Field name | Field type | Field description |
---|
fromField (required) | object | From field email address of messageField name | Field type | Field description |
---|
fromFieldId | string | FromFieldId from from-fields resources |
|
replyTo | object | Reply-to email address of messageField name | Field type | Field description |
---|
fromFieldId | string | FromFieldId from from-fields resources |
|
subject (required) | string | Subject of email, length: 1-512 bytes |
tag | object | Tag from tags resourcesField name | Field type | Field description |
---|
tagId (required) | string | Id of tag |
|
content (required) | object | Message content length limit is 16 MiB. Total decoded message size with attachments cannot exceed 32 MiB.Field name | Field type | Field description |
---|
plain | string | Plain message | html | string | HTML message |
|
recipients (required) | object | Recipients. Total number of recipients in To:, Cc: and Bcc: cannot exceed 8Field name | Field type | Field description |
---|
to | object | To: objectField name | Field type | Field description |
---|
validSince | string | When did this address appear in your system for the first time | email (required) | string | Email address | name | string | Recipient's name. Length: 1-128 |
| cc | collections | Cc: addresses | bcc | collections | Bcc: addresses |
|
attachments | collections | The collection of attachments. Total decoded message size with attachments cannot exceed 32 MiB |
Example Response
{
"transactionalEmailId": "uE5k"
}
Possible Errors