POST

/channels

http://service.chime.aws.amazon.com/channels

Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. <note> 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. </note>

Access Token Required: API Key

Body Params

Modestring

The channel mode: <code>UNRESTRICTED</code> or <code>RESTRICTED</code>. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

Namestringrequired

The name of the channel.

Tagsarray

The tags for the creation request.

Privacystring

The channel's privacy level: <code>PUBLIC</code> or <code>PRIVATE</code>. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the <code>AppInstance</code>.

Metadatastring

The metadata of the creation request. Limited to 1KB and UTF-8.

AppInstanceArnstringrequired

The ARN of the channel request.

ClientRequestTokenstringrequired

The client token for the request. An <code>Idempotency</code> token.

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' \
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}