v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Messages

Update external message status

Update the status of an outbound message by external ID. This endpoint is used by external systems (like SMS providers or custom channels) to notify Front when a message's delivery status has changed.

Available status changes:

failed: Mark a message as failed. When marked as failed, the conversation is reopened so the team can take action.

Note: This endpoint is only available for outbound messages.

put/channels/{channel_id}/conversations/{conv_ext_id}/messages/{message_ext_id}/status

Path parameters

channel_idstring required

The channel ID. Alternatively, you can supply the channel address as a resource alias.

conv_ext_idstring required

The conversation's external ID.

message_ext_idstring required

The message's external ID.

Request body

status'failed' required

The status to set for the message. Currently only 'failed' is supported.

reasonstring

Optional reason for the status change. This will be displayed to users and logged for debugging purposes.

Response

No content