Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451211217.9 KB

Sends a message to a particular channel that the member is a part of.

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.

Also, STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

CONTROL messages are limited to 30 bytes and do not contain metadata.

post/channels/{channelArn}/messages#x-amz-chime-bearer

Path parameters

channelArnstring required

The ARN of the channel.

Headers

x-amz-chime-bearerstring required

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

Request body

Contentstring password required

The content of the channel message.

Type'STANDARD' | 'CONTROL' required
<p>The type of message, <code>STANDARD</code> or <code>CONTROL</code>.</p> <p> <code>STANDARD</code> messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.</p> <p> <code>CONTROL</code> messages are limited to 30 bytes and do not contain metadata.</p>
Persistence'PERSISTENT' | 'NON_PERSISTENT' required

Boolean that controls whether the message is persisted on the back end. Required.

Metadatastring password

The optional metadata for each message.

ClientRequestTokenstring password required

The <code>Idempotency</code> token for each client request.

MessageAttributesobject

The attributes for the message, used for message filtering along with a <code>FilterRule</code> defined in the <code>PushNotificationPreferences</code>.

SubChannelIdstring

The ID of the SubChannel in the request.

ContentTypestring password

The content type of the channel message.

Response

Success

ChannelArnstring

The ARN of the channel.

MessageIdstring

The ID string assigned to each message.

SubChannelIdstring

The ID of the SubChannel in the response.