POST
/channels/{channelArn}/messages
http://service.chime.aws.amazon.com/channels/{channelArn}/messages<p>Sends a message to a particular channel that the member is a part of.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata. <code>CONTROL</code> messages can contain 30 bytes of data and no metadata.</p> </note>
Access Token Required: API Key
Path Parameters
channelArnstringrequired
The ARN of the channel.
Body Params
Typestringrequired
The type of message, <code>STANDARD</code> or <code>CONTROL</code>.
Contentstringrequired
The content of the message.
Metadatastring
The optional metadata for each message.
Persistencestringrequired
Boolean that controls whether the message is persisted on the back end. Required.
ClientRequestTokenstringrequired
The <code>Idempotency</code> token for each client request.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request POST \2 --url 'http://service.chime.aws.amazon.com/channels/{channelArn}/messages' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}