Batch
The Batch object represents an email that Is being sent to a specific category and a number of contacts. This object contains the following attributes:
Field
Type
Description
id
string
A primary identifier for the batch.
Example: MST-1234-9876-3333
href
string
A relative reference to the object.
Example: /v1/notifications/batches/MST-1234-9876-3333
category
Example:
{
"id": "NTC-1234-9876",
"href": "/v1/notifications/categories/NTC-1234-9876",
"name": "Orders",
"shortDescription": "Includes updates about order confirmations, order status updates, and related communications."
}
subject
string
The subject line for the email.
Example: Check out the new service offering
body
string
The body of the message.
attachments
attachment
Example:
[
{
"id": "ATT-1234-1234-1234",
"name": "Some mail attachment",
"contentType": "application/octet-stream",
"fileSize": 1234,
"fileName": "SomeFile.pdf",
"href": "/v1/notifications/messages/attachments/ATT-1234-1234-1234"
},
{
"id": "ATT-9876-9876-9876",
"name": "Some other mail attachment",
"contentType": "application/octet-stream",
"fileSize": 9876,
"fileName": "SomeOtherFile.pdf",
"href": "/v1/notifications/messages/attachments/ATT-9876-9876-9876"
}
]
Example
{
"id": "MST-1234-9876-3333",
"href": "/v1/notifications/batches/MST-1234-9876-3333",
"category": {
"id": "NTC-1234-9876",
"href": "/v1/notifications/categories/NTC-1234-9876",
"name": "Orders",
"shortDescription": "Includes updates about order confirmations, order status updates, and related communications."
},
"account": {
"id": "ACC-5131-0044",
"href": "/accounts/accounts/ACC-5131-0044",
"type": "Client",
"status": "Active",
"name": "SURFMARKET BV"
},
"subject": "Order published",
"body": "<b>Hello</b>",
}
Last updated
Was this helpful?