# Update service

**POST /v1/Services/{Sid}**


Top level scope for all chat resources

## Servers
- https://chat.twilio.com: https://chat.twilio.com ()


## Authentication methods
- Account sid auth token


## Parameters

### Path parameters
- **Sid** (string)
  The Twilio-provided string that uniquely identifies the Service resource to update.


### Body: application/x-www-form-urlencoded (object)

- **FriendlyName** (string)
  A descriptive string that you create to describe the resource. It can be up to 64 characters long.
- **DefaultServiceRoleSid** (string)
  The service role assigned to users when they are added to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
- **DefaultChannelRoleSid** (string)
  The channel role assigned to users when they are added to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
- **DefaultChannelCreatorRoleSid** (string)
  The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
- **ReadStatusEnabled** (boolean)
  Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The default is `true`.
- **ReachabilityEnabled** (boolean)
  Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/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. Can be: `true` or `false` and 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.AddedToChannel.Enabled** (boolean)
  Whether to send a notification when a member is added to a channel. Can be: `true` or `false` and 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.RemovedFromChannel.Enabled** (boolean)
  Whether to send a notification to a user when they are removed from a channel. Can be: `true` or `false` and 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.InvitedToChannel.Enabled** (boolean)
  Whether to send a notification when a user is invited to a channel. Can be: `true` or `false` and 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`.
- **PreWebhookUrl** (string(uri))
  The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.
- **PostWebhookUrl** (string(uri))
  The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) 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](https://www.twilio.com/docs/chat/webhook-events) for more details.
- **WebhookFilters** (array[string])
  The list of WebHook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.
- **Webhooks.OnMessageSend.Url** (string(uri))
  The URL of the webhook to call in response to the `on_message_send` event using the `webhooks.on_message_send.method` HTTP method.
- **Webhooks.OnMessageSend.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_message_send.url`.
- **Webhooks.OnMessageUpdate.Url** (string(uri))
  The URL of the webhook to call in response to the `on_message_update` event using the `webhooks.on_message_update.method` HTTP method.
- **Webhooks.OnMessageUpdate.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_message_update.url`.
- **Webhooks.OnMessageRemove.Url** (string(uri))
  The URL of the webhook to call in response to the `on_message_remove` event using the `webhooks.on_message_remove.method` HTTP method.
- **Webhooks.OnMessageRemove.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_message_remove.url`.
- **Webhooks.OnChannelAdd.Url** (string(uri))
  The URL of the webhook to call in response to the `on_channel_add` event using the `webhooks.on_channel_add.method` HTTP method.
- **Webhooks.OnChannelAdd.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_channel_add.url`.
- **Webhooks.OnChannelDestroy.Url** (string(uri))
  The URL of the webhook to call in response to the `on_channel_destroy` event using the `webhooks.on_channel_destroy.method` HTTP method.
- **Webhooks.OnChannelDestroy.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_channel_destroy.url`.
- **Webhooks.OnChannelUpdate.Url** (string(uri))
  The URL of the webhook to call in response to the `on_channel_update` event using the `webhooks.on_channel_update.method` HTTP method.
- **Webhooks.OnChannelUpdate.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_channel_update.url`.
- **Webhooks.OnMemberAdd.Url** (string(uri))
  The URL of the webhook to call in response to the `on_member_add` event using the `webhooks.on_member_add.method` HTTP method.
- **Webhooks.OnMemberAdd.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_member_add.url`.
- **Webhooks.OnMemberRemove.Url** (string(uri))
  The URL of the webhook to call in response to the `on_member_remove` event using the `webhooks.on_member_remove.method` HTTP method.
- **Webhooks.OnMemberRemove.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_member_remove.url`.
- **Webhooks.OnMessageSent.Url** (string(uri))
  The URL of the webhook to call in response to the `on_message_sent` event using the `webhooks.on_message_sent.method` HTTP method.
- **Webhooks.OnMessageSent.Method** (string(http-method))
  The URL of the webhook to call in response to the `on_message_sent` event`.
- **Webhooks.OnMessageUpdated.Url** (string(uri))
  The URL of the webhook to call in response to the `on_message_updated` event using the `webhooks.on_message_updated.method` HTTP method.
- **Webhooks.OnMessageUpdated.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_message_updated.url`.
- **Webhooks.OnMessageRemoved.Url** (string(uri))
  The URL of the webhook to call in response to the `on_message_removed` event using the `webhooks.on_message_removed.method` HTTP method.
- **Webhooks.OnMessageRemoved.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_message_removed.url`.
- **Webhooks.OnChannelAdded.Url** (string(uri))
  The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_added.method` HTTP method.
- **Webhooks.OnChannelAdded.Method** (string(http-method))
  The URL of the webhook to call in response to the `on_channel_added` event`.
- **Webhooks.OnChannelDestroyed.Url** (string(uri))
  The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_destroyed.method` HTTP method.
- **Webhooks.OnChannelDestroyed.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_channel_destroyed.url`.
- **Webhooks.OnChannelUpdated.Url** (string(uri))
  The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.
- **Webhooks.OnChannelUpdated.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_channel_updated.url`.
- **Webhooks.OnMemberAdded.Url** (string(uri))
  The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.
- **Webhooks.OnMemberAdded.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_channel_updated.url`.
- **Webhooks.OnMemberRemoved.Url** (string(uri))
  The URL of the webhook to call in response to the `on_member_removed` event using the `webhooks.on_member_removed.method` HTTP method.
- **Webhooks.OnMemberRemoved.Method** (string(http-method))
  The HTTP method to use when calling the `webhooks.on_member_removed.url`.
- **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.


## Responses
### 200
OK
#### Headers
- **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

#### Body: application/json (object)
- **sid** (string | null)
  The unique string that we created to identify the Service resource.
- **account_sid** (string | null)
  The SID of the [Account](https://www.twilio.com/docs/api/rest/account) that created the Service resource.
- **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 [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
- **date_updated** (string(date-time) | null)
  The date and time in GMT when the resource was last updated specified in [RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
- **default_service_role_sid** (string | null)
  The service role assigned to users when they are added to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
- **default_channel_role_sid** (string | null)
  The channel role assigned to users when they are added to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
- **default_channel_creator_role_sid** (string | null)
  The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.
- **read_status_enabled** (boolean | null)
  Whether the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature is enabled. The default is `true`.
- **reachability_enabled** (boolean | null)
  Whether the [Reachability Indicator](https://www.twilio.com/docs/chat/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.
- **consumption_report_interval** (integer)
  DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.
- **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.
- **webhooks** ()
  An object that contains information about the webhooks configured for this service.
- **pre_webhook_url** (string | null)
  The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) 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](https://www.twilio.com/docs/api/chat/webhooks) 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](https://www.twilio.com/docs/chat/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](https://www.twilio.com/docs/chat/webhook-events) for more details.
- **notifications** ()
  The notification configuration for the Service instance. See [Push Notification Configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more information.
- **url** (string(uri) | null)
  The absolute URL of the Service resource.
- **links** (object(uri-map) | null)
  The absolute URLs of the Service's [Channels](https://www.twilio.com/docs/chat/api/channels), [Roles](https://www.twilio.com/docs/chat/api/roles), and [Users](https://www.twilio.com/docs/chat/api/users).


[Powered by Bump.sh](https://bump.sh)