MOmonta
Messages

Retrieve a single message you have sent.

Changed on

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

get/api/v1/messages/{messageId}

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/messages/{messageId}
  • Auth
    HTTP bearer

Path parameters

messageIdstring required

Response

The requested message

idstring required

Id of the message.

userIdinteger

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",
  "userId": 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"
}

Changes

  • 0ca400461c52Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status