v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451211217.9 KB

Redacts message content and metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

post/channels/{channelArn}/messages/{messageId}#operation=redact&x-amz-chime-bearer

Path parameters

channelArnstring required

The ARN of the channel containing the messages that you want to redact.

messageIdstring required

The ID of the message being redacted.

Query parameters

operation'redact' required

Headers

x-amz-chime-bearerstring required

The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.

Request body

SubChannelIdstring

The ID of the SubChannel in the request.

Response

Success

ChannelArnstring

The ARN of the channel containing the messages that you want to redact.

MessageIdstring

The ID of the message being redacted.

SubChannelIdstring
<p>The ID of the SubChannel in the response.</p> <note> <p>Only required when redacting messages in a SubChannel that the user belongs to.</p> </note>