SEsentdm
Messages

Get message status

Changed on

Retrieves the current status and details of a message by ID. Includes delivery status, timestamps, and error information if applicable. A message that is or was held for a later time (a send you scheduled with scheduled_at, a quiet-hours hold, or a message you cancelled while it was held) is returned as a ScheduledMessageResponse: the same fields plus scheduled_at, the instant it is held for in UTC — or, on a CANCELLED message, the instant that was called off. A message sent immediately has no scheduled_at key.

get/v3/messages/{id}

Request

  • Base URL
    https://api.sent.dm
  • URL
    https://api.sent.dm/v3/messages/{id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

idstring uuid required

Message ID

Headers

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Response

Message retrieved successfully. data is a MessageResponse, or for a message that is or was held for a later time a ScheduledMessageResponse: the same fields plus scheduled_at

successboolean

Indicates whether the request was successful

Changes

  • 6c829543a93eRevision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      removed from the response property oneOf list for the response status

  • 1e113b6a003bRevision changes
    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status