> For the complete documentation index, see [llms.txt](https://docs.platform.softwareone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.platform.softwareone.com/developer-resources/rest-api/notifications-api/messages.md). # Message The Message object represents a single notification that was sent to a single contact. This object contains the following attributes:
FieldTypeDescription
idstring, core(Read-only) The primary identifier of the message.
hrefstring, core(Read-only) A relative reference to the object.
batchobject, core(Read-only) Represents the batch associated with the message.
contactobject, coreRepresents the contact object.
accountobjectRepresents the account object.
statusenum, core

The status of the notification message. Allowed values are:

  • Queued
  • Sent
  • Bounced
  • Complained
  • Discarded
subjectstring, coreThe subject line of the message.
categoryobject, coreRepresents the category object.
body Represents the body text.
attachmentsobject

(Read-only) Represents 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"
  }
]
auditobject(Read-only) Represents the audit object.
## Example {% code title="MESSAGE OBJECT" overflow="wrap" lineNumbers="true" %} ```json { "id": "MSG-1234-9876-4442-4314", "href": "/v1/notifications/messages/MSG-1234-9876-4442-4314", "batch": { "id": "MST-1234-9876-3333" }, "contact": { "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": { "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": "Sent", "subject": "Check out the new service offering", "body": "Hello", "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." }, "audit": { "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" } } } } ``` {% endcode %} [^1]: **Core** indicates the field is part of the base object schema. This is not the same as “required”. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.platform.softwareone.com/developer-resources/rest-api/notifications-api/messages.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.