Ctrlk
Sign InJoin
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Message

The Message object represents a single notification that was sent to a single contact.

This object contains the following attributes:

Field
Type
Description

id

string, core

(Read-only) The primary identifier of the message.

href

string, core

(Read-only) A relative reference to the object.

batch

object, core

(Read-only) Represents the batch associated with the message.

contact

object, core

Represents the contact object.

account

object

Represents the account object.

status

enum, core

The status of the notification message. Allowed values are:

  • Queued

  • Sent

  • Bounced

  • Complained

  • Discarded

subject

string, core

The subject line of the message.

category

object, core

Represents the category object.

body

Represents the body text.

attachments

object

(Read-only) Represents the attachment object.

Example:

audit

object

(Read-only) Represents the audit object.

Example

MESSAGE OBJECT
{
      "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": "<html><body><b>Hello</b></body></html>",
      "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"
          }
        }
      }
}
PreviousDelete footerNextState diagram

Last updated

Was this helpful?