Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14179784.8 KB

Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s <code>EventName</code> is <code>aws:DELETE_MESSAGE</code>. This replicates the <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html"> DeleteMessage</a> WebSocket operation in the Amazon IVS Chat Messaging API.

post/DeleteMessage

Request body

roomIdentifierstring required

Identifier of the room where the message should be deleted. Currently this must be an ARN.

idstring required

ID of the message to be deleted. This is the <code>Id</code> field in the received message (see <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html"> Message (Subscribe)</a> in the Chat Messaging API).

reasonstring

Reason for deleting the message.

Response

Success

idstring

Operation identifier, generated by Amazon IVS Chat.