id | string | The primary identifier for the message. Example: MSG-1234-9876-4442-4314 |
href | string | A relative reference to the object. Example: /v1/notifications/messages/MSG-1234-9876-4442-4314 |
batch | batch | The batch associated with the message. Example: {
"id": "MST-1234-9876-3333"
}
|
contact | object | A reference to the contact object. Example: {
"id": "CTT-1234-9876-1234",
"href": "/v1/notifications/contacts/CTT-1234-9876-1234",
"name": "Will Smith",
"email": "will.smith@softwareone.com",
"user": {
"id": "USR-3773-5838",
"href": "/accounts/users/USR-1234-9876",
"name": "Will Smith",
"email": "will.smith@softwareone.com"
}
}
|
account | object | A reference to the account object. Example: {
"id": "ACC-1671-0642",
"href": "/accounts/accounts/ACC-1671-0642",
"type": "Client",
"status": "Enabled",
"name": "You Are a Test Account",
"logo": "/accounts/accounts/ACC-1671-0642/logo.png"
}
|
status | enum | Allowed values: queued, sent, bounced, complained, or discarded. |
subject | string | The subject line of the message. Example: Check out the new service offering |
category | object | A reference to the category object. 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."
}
|
body | | Example: "<html><body><b>Hello</b></body></html>"
|
attachments | object | A reference to the attachment object. 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"
}
]
|
audit | object | A reference to the audit object. Example: "created": {
"at": "2023-12-14T17:28:57Z",
"by": {
"id": "UR-1234-1234-1234",
"name": "John Smith",
"icon": "/static/users/UR-1234-1234-1234.icon.svg"
},
"of": {
"id": "ACC-1234-1234",
"href": "/accounts/accounts/ACC-1234-1234",
"name": "Microsoft",
"icon": "/static/ACC-1234-1234/account.png"
}
}
|