Update channel

POST /v2/Services/{ServiceSid}/Channels/{Sid}

Account sid auth token

Channels represent chat rooms

Headers

X-Twilio-Webhook-Enabled string

The X-Twilio-Webhook-Enabled HTTP request header

Values are true or false.

Path parameters

ServiceSid string Required

The SID of the Service to update the Channel resource in.

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

The SID of the Channel resource to update. This value can be either the sid or the unique_name of the Channel resource to update.

application/x-www-form-urlencoded

Body

FriendlyName string

A descriptive string that you create to describe the resource. It can be up to 256 characters long.
UniqueName string

An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's sid in the URL. This value must be 256 characters or less in length and unique within the Service.
Attributes string

A valid JSON string that contains application-specific data.
DateCreated string(date-time)

The date, specified in ISO 8601 format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source.
DateUpdated string(date-time)

The date, specified in ISO 8601 format, to assign to the resource as the date it was last updated.
CreatedBy string

The identity of the User that created the channel. Default is: system.

Responses

200 application/json

OK
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- sid string | null
  
  The unique string that we created to identify the Channel resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^CH[0-9a-fA-F]{32}$.
- account_sid string | null
  
  The SID of the Account that created the Channel resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- service_sid string | null
  
  The SID of the Service the Channel resource is associated with.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.
- friendly_name string | null
  
  The string that you assigned to describe the resource.
- unique_name string | null
  
  An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's sid in the URL.
- attributes string | null
  
  The JSON string that stores application-specific data. If attributes have not been set, {} is returned.
- type string
  
  The visibility of the channel. Can be: public or private.
  
  Values are public or private.
- date_created string(date-time) | null
  
  The date and time in GMT when the resource was created specified in ISO 8601 format.
- date_updated string(date-time) | null
  
  The date and time in GMT when the resource was last updated specified in ISO 8601 format.
- created_by string | null
  
  The identity of the User that created the channel. If the Channel was created by using the API, the value is system.
- members_count integer
  
  The number of Members in the Channel.
  
  Default value is 0.
- messages_count integer
  
  The number of Messages that have been passed in the Channel.
  
  Default value is 0.
- url string(uri) | null
  
  The absolute URL of the Channel resource.
- links object(uri-map) | null
  
  The absolute URLs of the Members, Messages, Invites, Webhooks and, if it exists, the last Message for the Channel.

POST /v2/Services/{ServiceSid}/Channels/{Sid}

curl \
 --request POST 'https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{Sid}' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --header "X-Twilio-Webhook-Enabled: true" \
 --data 'Type=channel&CreatedBy=username&Attributes=%7B+%22foo%22%3A+%22bar%22+%7D&UniqueName=unique_name&DateCreated=2015-12-16T22%3A18%3A37Z&DateUpdated=2015-12-16T22%3A18%3A38Z&FriendlyName=friendly_name'

Request example

{"Type"=>"channel", "CreatedBy"=>"username", "Attributes"=>"{ \"foo\": \"bar\" }", "UniqueName"=>"unique_name", "DateCreated"=>"2015-12-16T22:18:37Z", "DateUpdated"=>"2015-12-16T22:18:38Z", "FriendlyName"=>"friendly_name"}

Response examples (200)

{
  "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "type": "public",
  "links": {
    "invites": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites",
    "members": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members",
    "messages": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages",
    "webhooks": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks",
    "last_message": null
  },
  "attributes": "{ \"foo\": \"bar\" }",
  "created_by": "username",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "unique_name": "unique_name",
  "date_created": "2015-12-16T22:18:37Z",
  "date_updated": "2015-12-16T22:18:38Z",
  "friendly_name": "friendly_name",
  "members_count": 0,
  "messages_count": 0
}