Create a channel binding
POST /v1/channel-bindings · SDK createChannelBinding · CLI deployments channel-binding create
Requires channels:write.
AuthorizationBearer <token>Opaque bearer credential scoped to one service account and tenant.
x-deployments-environment?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-organization?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-project?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$idempotency-key*stringMust contain 1–256 UTF-8 bytes with no surrounding whitespace or control characters (U+0000–U+001F and U+007F); maxLength is only a character-count approximation.
^(?!\s)(?!.*\s$)[^\u0000-\u001F\u007F]+$1 <= length <= 256application/json- body
agentDefinitionId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$agentDeploymentId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$channel*string"imessage""rcs""slack""sms""teams""telegram"connectionId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$externalAccountId?string^\S[\s\S]*\S$|^\S$|^$1 <= length <= 512externalChannelId?string^\S[\s\S]*\S$|^\S$|^$1 <= length <= 512externalThreadKey?string^\S[\s\S]*\S$|^\S$|^$1 <= length <= 1024externalWorkspaceId?string^\S[\s\S]*\S$|^\S$|^$1 <= length <= 512metadata?provider*string"aws_end_user_messaging_rcs""slack_cloudflare_edge""slack_edge""teams_bot_framework""telegram"workspaceId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$ChannelBindingResponse
application/json- response
createdAt*string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timeupdatedAt*string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timeversion*number|||environmentId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$organizationId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$projectId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$workspaceId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$agentDefinitionId*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$agentDeploymentId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$channel*string"imessage""rcs""slack""sms""teams""telegram"connectionId?string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$credentialAttached*booleanexternalAccountId?stringexternalChannelId?stringexternalThreadKey?stringexternalWorkspaceId?stringid*string^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$lastVerifiedAt?string^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$date-timemetadata?object*"channel-binding""channel-binding"provider*string"aws_end_user_messaging_rcs""slack_cloudflare_edge""slack_edge""teams_bot_framework""telegram"status*string"active""archived""disabled"curl -X POST "https://example.com/v1/channel-bindings" \ -H "idempotency-key: string" \ -H "Content-Type: application/json" \ -d '{ "agentDefinitionId": "string", "agentDeploymentId": "string", "channel": "imessage", "provider": "aws_end_user_messaging_rcs" }'{ "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "environmentId": "string", "organizationId": "string", "projectId": "string", "workspaceId": "string", "agentDefinitionId": "string", "agentDeploymentId": "string", "channel": "imessage", "connectionId": "string", "credentialAttached": true, "externalAccountId": "string", "externalChannelId": "string", "externalThreadKey": "string", "externalWorkspaceId": "string", "id": "string", "lastVerifiedAt": "2019-08-24T14:15:22Z", "metadata": {}, "object": "channel-binding", "provider": "aws_end_user_messaging_rcs", "status": "active"}