Update configuration settings of a conversation service

POST /v1/Services/{ChatServiceSid}/Configuration

A Service Configuration resource manages service-level settings applicable to the Conversation API.

Update configuration settings of a conversation service

Path parameters

  • ChatServiceSid string Required

    The SID of the Service configuration resource to update.

application/x-www-form-urlencoded

Body

  • DefaultChatServiceRoleSid string

    The service-level role assigned to users when they are added to the service. See the Conversation Role for more info about roles.

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

  • DefaultConversationCreatorRoleSid string

    The conversation-level role assigned to a conversation creator when they join a new conversation. See the Conversation Role for more info about roles.

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

  • DefaultConversationRoleSid string

    The conversation-level role assigned to users when they are added to a conversation. See the Conversation Role for more info about roles.

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

  • ReachabilityEnabled boolean

    Whether the Reachability Indicator is enabled for this Conversations Service. The default is false.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • chat_service_sid string | null

      The unique string that identifies the resource

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

    • default_chat_service_role_sid string | null

      The service role assigned to users when they are added to the service

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

    • default_conversation_creator_role_sid string | null

      The role assigned to a conversation creator user when they join a new conversation

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

    • default_conversation_role_sid string | null

      The role assigned to users when they are added to a conversation

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

    • links object(uri-map) | null

      Absolute URL to access the push notifications configuration of this service.

    • reachability_enabled boolean | null

      Whether the Reachability Indicator feature is enabled for this Conversations Service

    • url string(uri) | null

      An absolute URL for this service configuration.
POST /v1/Services/{ChatServiceSid}/Configuration 
curl \
 -X POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'DefaultChatServiceRoleSid=string&DefaultConversationCreatorRoleSid=string&DefaultConversationRoleSid=string&ReachabilityEnabled=true'
Request example 
{
  "DefaultChatServiceRoleSid": "string",
  "DefaultConversationCreatorRoleSid": "string",
  "DefaultConversationRoleSid": "string",
  "ReachabilityEnabled": true
}
Response examples (200) 
{
  "chat_service_sid": "string",
  "default_chat_service_role_sid": "string",
  "default_conversation_creator_role_sid": "string",
  "default_conversation_role_sid": "string",
  "links": {},
  "reachability_enabled": true,
  "url": "https://example.com"
}