Create web channel

POST /v1/WebChannels

TODO: Resource-level docs

Body

ChatFriendlyName string Required

The chat channel's friendly name.
ChatUniqueName string

The chat channel's unique name.
CustomerFriendlyName string Required

The chat participant's friendly name.
FlexFlowSid string Required

The SID of the Flex Flow.

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FO[0-9a-fA-F]{32}$.
Identity string Required

The chat identity.
PreEngagementData string

The pre-engagement data.

Responses

201

Created
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account that created the resource and owns this Workflow
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- date_created string(date-time) | null
  
  The ISO 8601 date and time in GMT when the resource was created
- date_updated string(date-time) | null
  
  The ISO 8601 date and time in GMT when the resource was last updated
- flex_flow_sid string | null
  
  The SID of the Flex Flow
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FO[0-9a-fA-F]{32}$.
- sid string | null
  
  The unique string that identifies the WebChannel resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.
- url string(uri) | null
  
  The absolute URL of the WebChannel resource

POST /v1/WebChannels

curl \
 -X POST https://flex-api.twilio.com/v1/WebChannels \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'ChatFriendlyName=string&ChatUniqueName=string&CustomerFriendlyName=string&FlexFlowSid=string&Identity=string&PreEngagementData=string'

Request example

{
  "ChatFriendlyName": "string",
  "ChatUniqueName": "string",
  "CustomerFriendlyName": "string",
  "FlexFlowSid": "string",
  "Identity": "string",
  "PreEngagementData": "string"
}

Request examples

{
  "ChatFriendlyName": "string",
  "ChatUniqueName": "string",
  "CustomerFriendlyName": "string",
  "FlexFlowSid": "string",
  "Identity": "string",
  "PreEngagementData": "string"
}

Response examples (201)

{
  "account_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "flex_flow_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}

Response examples (201)

{
  "account_sid": "string",
  "date_created": "2025-05-04T09:42:00Z",
  "date_updated": "2025-05-04T09:42:00Z",
  "flex_flow_sid": "string",
  "sid": "string",
  "url": "https://example.com"
}