Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Messages

Retrieve a single message you have sent.

Retrieves a message your operator sent, including its per-channel delivery status. Required scope: messages:read

get/api/v1/messages/{messageId}

Path parameters

messageIdstring required

Response

The requested message

idstring required

Id of the message.

recipientUserIdinteger

Id of the user the message was sent to.

bodystring required

The message body.

subjectstring nullable

Subject / title, if one was set.

actionUrlstring nullable

Deep link carried by the message, if any.

readAtstring date-time nullable

When the recipient read the message, or null if unread.

createdAtstring date-time required

When the message was created.

Example response

{
  "id": "1024",
  "recipientUserId": 42,
  "body": "Your charge at Main Street is complete.",
  "subject": "Charge complete",
  "channels": {
    "webInbox": true
  },
  "deliveryResults": {
    "webInbox": {
      "status": "delivered",
      "at": "2026-06-26T13:40:01Z"
    },
    "mobilePush": {
      "status": "delivered",
      "at": "2026-06-26T13:40:01Z"
    },
    "email": {
      "status": "delivered",
      "at": "2026-06-26T13:40:01Z"
    },
    "sms": {
      "status": "delivered",
      "at": "2026-06-26T13:40:01Z"
    }
  },
  "readAt": "2026-06-26T13:47:14.123Z",
  "createdAt": "2026-06-26T13:40:00Z"
}