Update a specific Channel.

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

A Channel resource represents a chat/conversation channel with an ordered list of messages and a participant roster.

Update a specific Channel.

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 unique SID identifier of the Service.

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

  • Sid string Required

    A 34 character string that uniquely identifies this Channel.

application/x-www-form-urlencoded

Body

  • Type string

    The visibility of the channel. Can be: public or private.

    Values are public or private.

  • MessagingServiceSid string

    The unique ID of the Messaging Service this channel belongs to.

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

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.

    • messaging_service_sid string | null

      The unique ID of the Messaging Service this channel belongs to.

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

    • url string(uri) | null

      The absolute URL of the Channel resource.

POST /v3/Services/{ServiceSid}/Channels/{Sid}
curl \
 --request POST 'https://chat.twilio.com/v3/Services/{ServiceSid}/Channels/{Sid}' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --header "X-Twilio-Webhook-Enabled: true" \
 --data 'Type=private&MessagingServiceSid=MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
Request example
{"Type"=>"private", "MessagingServiceSid"=>"MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}
Response examples (200)
{
  "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://chat.twilio.com/v3/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "type": "public",
  "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,
  "messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}