Update service

POST /v2/Services/{Sid}

Account sid auth token

Top level scope for all chat resources

Path parameters

Sid string Required

The SID of the Service resource to update.

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

application/x-www-form-urlencoded

Body

FriendlyName string

A descriptive string that you create to describe the resource.
DefaultServiceRoleSid string

The service role assigned to users when they are added to the service. See the Role resource 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}$.
DefaultChannelRoleSid string

The channel role assigned to users when they are added to a channel. See the Role resource 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}$.
DefaultChannelCreatorRoleSid string

The channel role assigned to a channel creator when they join a new channel. See the Role resource 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}$.
ReadStatusEnabled boolean

Whether to enable the Message Consumption Horizon feature. The default is true.
ReachabilityEnabled boolean

Whether to enable the Reachability Indicator for this Service instance. The default is false.
TypingIndicatorTimeout integer

How long in seconds after a started typing event until clients should assume that user is no longer typing, even if no ended typing message was received. The default is 5 seconds.
ConsumptionReportInterval integer

DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.
Notifications.NewMessage.Enabled boolean

Whether to send a notification when a new message is added to a channel. The default is false.
Notifications.NewMessage.Template string

The template to use to create the notification text displayed when a new message is added to a channel and notifications.new_message.enabled is true.
Notifications.NewMessage.Sound string

The name of the sound to play when a new message is added to a channel and notifications.new_message.enabled is true.
Notifications.NewMessage.BadgeCountEnabled boolean

Whether the new message badge is enabled. The default is false.
Notifications.AddedToChannel.Enabled boolean

Whether to send a notification when a member is added to a channel. The default is false.
Notifications.AddedToChannel.Template string

The template to use to create the notification text displayed when a member is added to a channel and notifications.added_to_channel.enabled is true.
Notifications.AddedToChannel.Sound string

The name of the sound to play when a member is added to a channel and notifications.added_to_channel.enabled is true.
Notifications.RemovedFromChannel.Enabled boolean

Whether to send a notification to a user when they are removed from a channel. The default is false.
Notifications.RemovedFromChannel.Template string

The template to use to create the notification text displayed to a user when they are removed from a channel and notifications.removed_from_channel.enabled is true.
Notifications.RemovedFromChannel.Sound string

The name of the sound to play to a user when they are removed from a channel and notifications.removed_from_channel.enabled is true.
Notifications.InvitedToChannel.Enabled boolean

Whether to send a notification when a user is invited to a channel. The default is false.
Notifications.InvitedToChannel.Template string

The template to use to create the notification text displayed when a user is invited to a channel and notifications.invited_to_channel.enabled is true.
Notifications.InvitedToChannel.Sound string

The name of the sound to play when a user is invited to a channel and notifications.invited_to_channel.enabled is true.
PreWebhookUrl string(uri)

The URL for pre-event webhooks, which are called by using the webhook_method. See Webhook Events for more details.
PostWebhookUrl string(uri)

The URL for post-event webhooks, which are called by using the webhook_method. See Webhook Events for more details.
WebhookMethod string(http-method)

The HTTP method to use for calls to the pre_webhook_url and post_webhook_url webhooks. Can be: POST or GET and the default is POST. See Webhook Events for more details.

Values are GET or POST.
WebhookFilters array[string]

The list of webhook events that are enabled for this Service instance. See Webhook Events for more details.
Limits.ChannelMembers integer

The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.
Limits.UserChannels integer

The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.
Media.CompatibilityMessage string

The message to send when a media message has no text. Can be used as placeholder message.
PreWebhookRetryCount integer

The number of times to retry a call to the pre_webhook_url if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried.
PostWebhookRetryCount integer

The number of times to retry a call to the post_webhook_url if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried.
Notifications.LogEnabled boolean

Whether to log notifications. The default is false.

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 Service resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.
- account_sid string | null
  
  The SID of the Account that created the Service resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- friendly_name string | null
  
  The string that you assigned to describe the resource.
- 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.
- default_service_role_sid string | null
  
  The service role assigned to users when they are added to the service. See the Role resource 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}$.
- default_channel_role_sid string | null
  
  The channel role assigned to users when they are added to a channel. See the Role resource 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}$.
- default_channel_creator_role_sid string | null
  
  The channel role assigned to a channel creator when they join a new channel. See the Role resource 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}$.
- read_status_enabled boolean | null
  
  Whether the Message Consumption Horizon feature is enabled. The default is true.
- reachability_enabled boolean | null
  
  Whether the Reachability Indicator is enabled for this Service instance. The default is false.
- typing_indicator_timeout integer
  
  How long in seconds after a started typing event until clients should assume that user is no longer typing, even if no ended typing message was received. The default is 5 seconds.
  
  Default value is 0.
- consumption_report_interval integer
  
  DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.
  
  Default value is 0.
- limits
  
  An object that describes the limits of the service instance. The limits object contains channel_members to describe the members/channel limit and user_channels to describe the channels/user limit. channel_members can be 1,000 or less, with a default of 250. user_channels can be 1,000 or less, with a default value of 100.
- pre_webhook_url string | null
  
  The URL for pre-event webhooks, which are called by using the webhook_method. See Webhook Events for more details.
- post_webhook_url string | null
  
  The URL for post-event webhooks, which are called by using the webhook_method. See Webhook Events for more details.
- webhook_method string | null
  
  The HTTP method to use for calls to the pre_webhook_url and post_webhook_url webhooks. Can be: POST or GET and the default is POST. See Webhook Events for more details.
- webhook_filters array[string] | null
  
  The list of webhook events that are enabled for this Service instance. See Webhook Events for more details.
- pre_webhook_retry_count integer
  
  The number of times to retry a call to the pre_webhook_url if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried.
  
  Default value is 0.
- post_webhook_retry_count integer
  
  The number of times to retry a call to the post_webhook_url if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried.
  
  Default value is 0.
- notifications
  
  The notification configuration for the Service instance. See Push Notification Configuration for more info.
- media
  
  An object that describes the properties of media that the service supports. The object contains the size_limit_mb property, which describes the size of the largest media file in MB; and the compatibility_message property, which contains the message text to send when a media message does not have any text.
- url string(uri) | null
  
  The absolute URL of the Service resource.
- links object(uri-map) | null
  
  The absolute URLs of the Service's Channels, Roles, Bindings, and Users.

POST /v2/Services/{Sid}

curl \
 --request POST 'https://chat.twilio.com/v2/Services/{Sid}' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'FriendlyName=friendly_name&PreWebhookUrl=pre_webhook_url&WebhookMethod=webhook_method&PostWebhookUrl=post_webhook_url&WebhookFilters=webhook_filters&ReadStatusEnabled=false&Limits.UserChannels=500&ReachabilityEnabled=false&PreWebhookRetryCount=2&DefaultChannelRoleSid=RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DefaultServiceRoleSid=RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Limits.ChannelMembers=600&PostWebhookRetryCount=3&TypingIndicatorTimeout=100&Notifications.LogEnabled=true&ConsumptionReportInterval=100&Media.CompatibilityMessage=new+media+compatibility+message&DefaultChannelCreatorRoleSid=RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Notifications.NewMessage.Enabled=false&Notifications.NewMessage.Template=notifications.new_message.template&Notifications.AddedToChannel.Enabled=false&Notifications.AddedToChannel.Template=notifications.added_to_channel.template&Notifications.InvitedToChannel.Enabled=false&Notifications.InvitedToChannel.Template=notifications.invited_to_channel.template&Notifications.RemovedFromChannel.Enabled=false&Notifications.RemovedFromChannel.Template=notifications.removed_from_channel.template&Notifications.NewMessage.BadgeCountEnabled=true'

Request example

{"FriendlyName"=>"friendly_name", "PreWebhookUrl"=>"pre_webhook_url", "WebhookMethod"=>"webhook_method", "PostWebhookUrl"=>"post_webhook_url", "WebhookFilters"=>["webhook_filters"], "ReadStatusEnabled"=>false, "Limits.UserChannels"=>500, "ReachabilityEnabled"=>false, "PreWebhookRetryCount"=>2, "DefaultChannelRoleSid"=>"RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "DefaultServiceRoleSid"=>"RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "Limits.ChannelMembers"=>600, "PostWebhookRetryCount"=>3, "TypingIndicatorTimeout"=>100, "Notifications.LogEnabled"=>true, "ConsumptionReportInterval"=>100, "Media.CompatibilityMessage"=>"new media compatibility message", "DefaultChannelCreatorRoleSid"=>"RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "Notifications.NewMessage.Enabled"=>false, "Notifications.NewMessage.Template"=>"notifications.new_message.template", "Notifications.AddedToChannel.Enabled"=>false, "Notifications.AddedToChannel.Template"=>"notifications.added_to_channel.template", "Notifications.InvitedToChannel.Enabled"=>false, "Notifications.InvitedToChannel.Template"=>"notifications.invited_to_channel.template", "Notifications.RemovedFromChannel.Enabled"=>false, "Notifications.RemovedFromChannel.Template"=>"notifications.removed_from_channel.template", "Notifications.NewMessage.BadgeCountEnabled"=>true}

Response examples (200)

{
  "sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "roles": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles",
    "users": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users",
    "bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings",
    "channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels"
  },
  "media": {
    "size_limit_mb": 150,
    "compatibility_message": "new media compatibility message"
  },
  "limits": {
    "user_channels": 600,
    "channel_members": 500
  },
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2015-07-30T20:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z",
  "friendly_name": "friendly_name",
  "notifications": {
    "log_enabled": true,
    "new_message": {
      "enabled": false,
      "template": "notifications.new_message.template",
      "badge_count_enabled": true
    },
    "added_to_channel": {
      "enabled": false,
      "template": "notifications.added_to_channel.template"
    },
    "invited_to_channel": {
      "enabled": false,
      "template": "notifications.invited_to_channel.template"
    },
    "removed_from_channel": {
      "enabled": false,
      "template": "notifications.removed_from_channel.template"
    }
  },
  "webhook_method": "webhook_method",
  "pre_webhook_url": "pre_webhook_url",
  "webhook_filters": [
    "webhook_filters"
  ],
  "post_webhook_url": "post_webhook_url",
  "read_status_enabled": false,
  "reachability_enabled": false,
  "pre_webhook_retry_count": 2,
  "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "post_webhook_retry_count": 3,
  "typing_indicator_timeout": 100,
  "consumption_report_interval": 100,
  "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}