Path parameters
-
The Twilio-provided string that uniquely identifies the Service resource to update.
Minimum length is
34
, maximum length is34
. Format should match the following pattern:^IS[0-9a-fA-F]{32}$
.
Body
-
A descriptive string that you create to describe the resource. It can be up to 64 characters long.
-
The service role assigned to users when they are added to the service. See the Roles endpoint for more details.
Minimum length is
34
, maximum length is34
. Format should match the following pattern:^RL[0-9a-fA-F]{32}$
. -
The channel role assigned to users when they are added to a channel. See the Roles endpoint for more details.
Minimum length is
34
, maximum length is34
. Format should match the following pattern:^RL[0-9a-fA-F]{32}$
. -
The channel role assigned to a channel creator when they join a new channel. See the Roles endpoint for more details.
Minimum length is
34
, maximum length is34
. Format should match the following pattern:^RL[0-9a-fA-F]{32}$
. -
Whether to enable the Message Consumption Horizon feature. The default is
true
. -
Whether to enable the Reachability Indicator for this Service instance. The default is
false
. -
How long in seconds after a
started typing
event until clients should assume that user is no longer typing, even if noended typing
message was received. The default is 5 seconds. -
DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.
-
Whether to send a notification when a new message is added to a channel. Can be:
true
orfalse
and the default isfalse
. -
The template to use to create the notification text displayed when a new message is added to a channel and
notifications.new_message.enabled
istrue
. -
Whether to send a notification when a member is added to a channel. Can be:
true
orfalse
and the default isfalse
. -
The template to use to create the notification text displayed when a member is added to a channel and
notifications.added_to_channel.enabled
istrue
. -
Whether to send a notification to a user when they are removed from a channel. Can be:
true
orfalse
and the default isfalse
. -
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
istrue
. -
Whether to send a notification when a user is invited to a channel. Can be:
true
orfalse
and the default isfalse
. -
The template to use to create the notification text displayed when a user is invited to a channel and
notifications.invited_to_channel.enabled
istrue
. -
The URL for pre-event webhooks, which are called by using the
webhook_method
. See Webhook Events for more details. -
The URL for post-event webhooks, which are called by using the
webhook_method
. See Webhook Events for more details. -
The HTTP method to use for calls to the
pre_webhook_url
andpost_webhook_url
webhooks. Can be:POST
orGET
and the default isPOST
. See Webhook Events for more details.Values are
GET
orPOST
. -
The list of WebHook events that are enabled for this Service instance. See Webhook Events for more details.
-
The URL of the webhook to call in response to the
on_message_send
event using thewebhooks.on_message_send.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_message_send.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_message_update
event using thewebhooks.on_message_update.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_message_update.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_message_remove
event using thewebhooks.on_message_remove.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_message_remove.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_channel_add
event using thewebhooks.on_channel_add.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_channel_add.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_channel_destroy
event using thewebhooks.on_channel_destroy.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_channel_destroy.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_channel_update
event using thewebhooks.on_channel_update.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_channel_update.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_member_add
event using thewebhooks.on_member_add.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_member_add.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_member_remove
event using thewebhooks.on_member_remove.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_member_remove.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_message_sent
event using thewebhooks.on_message_sent.method
HTTP method. -
The URL of the webhook to call in response to the
on_message_sent
event`.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_message_updated
event using thewebhooks.on_message_updated.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_message_updated.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_message_removed
event using thewebhooks.on_message_removed.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_message_removed.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_channel_added
event using thewebhooks.on_channel_added.method
HTTP method. -
The URL of the webhook to call in response to the
on_channel_added
event`.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_channel_added
event using thewebhooks.on_channel_destroyed.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_channel_destroyed.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_channel_updated
event using thewebhooks.on_channel_updated.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_channel_updated.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_channel_updated
event using thewebhooks.on_channel_updated.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_channel_updated.url
.Values are
GET
orPOST
. -
The URL of the webhook to call in response to the
on_member_removed
event using thewebhooks.on_member_removed.method
HTTP method. -
The HTTP method to use when calling the
webhooks.on_member_removed.url
.Values are
GET
orPOST
. -
The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.
-
The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.
curl \
--request POST 'https://chat.twilio.com/v1/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&DefaultChannelRoleSid=RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DefaultServiceRoleSid=RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Limits.ChannelMembers=600&TypingIndicatorTimeout=100&Webhooks.OnMemberAdd.Url=webhooks.on_member_add.url&ConsumptionReportInterval=100&Webhooks.OnChannelAdd.Url=webhooks.on_channel_add.url&Webhooks.OnMemberAdded.Url=webhooks.on_member_added.url&Webhooks.OnMessageSend.Url=webhooks.on_message_send.url&Webhooks.OnMessageSent.Url=webhooks.on_message_sent.url&Webhooks.OnChannelAdded.Url=webhooks.on_channel_added.url&Webhooks.OnMemberAdd.Format=webhooks.on_member_add.format&Webhooks.OnMemberAdd.Method=webhooks.on_member_add.method&Webhooks.OnMemberRemove.Url=webhooks.on_member_remove.url&DefaultChannelCreatorRoleSid=RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&Webhooks.OnChannelAdd.Format=webhooks.on_channel_add.format&Webhooks.OnChannelAdd.Method=webhooks.on_channel_add.method&Webhooks.OnChannelUpdate.Url=webhooks.on_channel_update.url&Webhooks.OnMemberRemoved.Url=webhooks.on_member_removed.url&Webhooks.OnMessageRemove.Url=webhooks.on_message_remove.url&Webhooks.OnMessageUpdate.Url=webhooks.on_message_update.url&Webhooks.OnChannelDestroy.Url=webhooks.on_channel_destroy.url&Webhooks.OnChannelUpdated.Url=webhooks.on_channel_updated.url&Webhooks.OnMemberAdded.Format=webhooks.on_member_added.format&Webhooks.OnMemberAdded.Method=webhooks.on_member_added.method&Webhooks.OnMessageRemoved.Url=webhooks.on_message_removed.url&Webhooks.OnMessageSend.Format=webhooks.on_message_send.format&Webhooks.OnMessageSend.Method=webhooks.on_message_send.method&Webhooks.OnMessageSent.Format=webhooks.on_message_sent.format&Webhooks.OnMessageSent.Method=webhooks.on_message_sent.method&Webhooks.OnMessageUpdated.Url=webhooks.on_message_updated.url&Webhooks.OnChannelAdded.Format=webhooks.on_channel_added.format&Webhooks.OnChannelAdded.Method=webhooks.on_channel_added.method&Webhooks.OnMemberRemove.Format=webhooks.on_member_remove.format&Webhooks.OnMemberRemove.Method=webhooks.on_member_remove.method&Webhooks.OnChannelDestroyed.Url=webhooks.on_channel_destroyed.url&Webhooks.OnChannelUpdate.Format=webhooks.on_channel_update.format&Webhooks.OnChannelUpdate.Method=webhooks.on_channel_update.method&Webhooks.OnMemberRemoved.Format=webhooks.on_member_removed.format&Webhooks.OnMemberRemoved.Method=webhooks.on_member_removed.method&Webhooks.OnMessageRemove.Format=webhooks.on_message_remove.format&Webhooks.OnMessageRemove.Method=webhooks.on_message_remove.method&Webhooks.OnMessageUpdate.Format=webhooks.on_message_update.format&Webhooks.OnMessageUpdate.Method=webhooks.on_message_update.method&Notifications.NewMessage.Enabled=false&Webhooks.OnChannelDestroy.Format=webhooks.on_channel_destroy.format&Webhooks.OnChannelDestroy.Method=webhooks.on_channel_destroy.method&Webhooks.OnChannelUpdated.Format=webhooks.on_channel_updated.format&Webhooks.OnChannelUpdated.Method=webhooks.on_channel_updated.method&Webhooks.OnMessageRemoved.Format=webhooks.on_message_removed.format&Webhooks.OnMessageRemoved.Method=webhooks.on_message_removed.method&Webhooks.OnMessageUpdated.Format=webhooks.on_message_updated.format&Webhooks.OnMessageUpdated.Method=webhooks.on_message_updated.method&Notifications.NewMessage.Template=notifications.new_message.template&Webhooks.OnChannelDestroyed.Format=webhooks.on_channel_destroyed.format&Webhooks.OnChannelDestroyed.Method=webhooks.on_channel_destroyed.method&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'
{"FriendlyName"=>"friendly_name", "PreWebhookUrl"=>"pre_webhook_url", "WebhookMethod"=>"webhook_method", "PostWebhookUrl"=>"post_webhook_url", "WebhookFilters"=>["webhook_filters"], "ReadStatusEnabled"=>false, "Limits.UserChannels"=>500, "ReachabilityEnabled"=>false, "DefaultChannelRoleSid"=>"RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "DefaultServiceRoleSid"=>"RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "Limits.ChannelMembers"=>600, "TypingIndicatorTimeout"=>100, "Webhooks.OnMemberAdd.Url"=>"webhooks.on_member_add.url", "ConsumptionReportInterval"=>100, "Webhooks.OnChannelAdd.Url"=>"webhooks.on_channel_add.url", "Webhooks.OnMemberAdded.Url"=>"webhooks.on_member_added.url", "Webhooks.OnMessageSend.Url"=>"webhooks.on_message_send.url", "Webhooks.OnMessageSent.Url"=>"webhooks.on_message_sent.url", "Webhooks.OnChannelAdded.Url"=>"webhooks.on_channel_added.url", "Webhooks.OnMemberAdd.Format"=>"webhooks.on_member_add.format", "Webhooks.OnMemberAdd.Method"=>"webhooks.on_member_add.method", "Webhooks.OnMemberRemove.Url"=>"webhooks.on_member_remove.url", "DefaultChannelCreatorRoleSid"=>"RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "Webhooks.OnChannelAdd.Format"=>"webhooks.on_channel_add.format", "Webhooks.OnChannelAdd.Method"=>"webhooks.on_channel_add.method", "Webhooks.OnChannelUpdate.Url"=>"webhooks.on_channel_update.url", "Webhooks.OnMemberRemoved.Url"=>"webhooks.on_member_removed.url", "Webhooks.OnMessageRemove.Url"=>"webhooks.on_message_remove.url", "Webhooks.OnMessageUpdate.Url"=>"webhooks.on_message_update.url", "Webhooks.OnChannelDestroy.Url"=>"webhooks.on_channel_destroy.url", "Webhooks.OnChannelUpdated.Url"=>"webhooks.on_channel_updated.url", "Webhooks.OnMemberAdded.Format"=>"webhooks.on_member_added.format", "Webhooks.OnMemberAdded.Method"=>"webhooks.on_member_added.method", "Webhooks.OnMessageRemoved.Url"=>"webhooks.on_message_removed.url", "Webhooks.OnMessageSend.Format"=>"webhooks.on_message_send.format", "Webhooks.OnMessageSend.Method"=>"webhooks.on_message_send.method", "Webhooks.OnMessageSent.Format"=>"webhooks.on_message_sent.format", "Webhooks.OnMessageSent.Method"=>"webhooks.on_message_sent.method", "Webhooks.OnMessageUpdated.Url"=>"webhooks.on_message_updated.url", "Webhooks.OnChannelAdded.Format"=>"webhooks.on_channel_added.format", "Webhooks.OnChannelAdded.Method"=>"webhooks.on_channel_added.method", "Webhooks.OnMemberRemove.Format"=>"webhooks.on_member_remove.format", "Webhooks.OnMemberRemove.Method"=>"webhooks.on_member_remove.method", "Webhooks.OnChannelDestroyed.Url"=>"webhooks.on_channel_destroyed.url", "Webhooks.OnChannelUpdate.Format"=>"webhooks.on_channel_update.format", "Webhooks.OnChannelUpdate.Method"=>"webhooks.on_channel_update.method", "Webhooks.OnMemberRemoved.Format"=>"webhooks.on_member_removed.format", "Webhooks.OnMemberRemoved.Method"=>"webhooks.on_member_removed.method", "Webhooks.OnMessageRemove.Format"=>"webhooks.on_message_remove.format", "Webhooks.OnMessageRemove.Method"=>"webhooks.on_message_remove.method", "Webhooks.OnMessageUpdate.Format"=>"webhooks.on_message_update.format", "Webhooks.OnMessageUpdate.Method"=>"webhooks.on_message_update.method", "Notifications.NewMessage.Enabled"=>false, "Webhooks.OnChannelDestroy.Format"=>"webhooks.on_channel_destroy.format", "Webhooks.OnChannelDestroy.Method"=>"webhooks.on_channel_destroy.method", "Webhooks.OnChannelUpdated.Format"=>"webhooks.on_channel_updated.format", "Webhooks.OnChannelUpdated.Method"=>"webhooks.on_channel_updated.method", "Webhooks.OnMessageRemoved.Format"=>"webhooks.on_message_removed.format", "Webhooks.OnMessageRemoved.Method"=>"webhooks.on_message_removed.method", "Webhooks.OnMessageUpdated.Format"=>"webhooks.on_message_updated.format", "Webhooks.OnMessageUpdated.Method"=>"webhooks.on_message_updated.method", "Notifications.NewMessage.Template"=>"notifications.new_message.template", "Webhooks.OnChannelDestroyed.Format"=>"webhooks.on_channel_destroyed.format", "Webhooks.OnChannelDestroyed.Method"=>"webhooks.on_channel_destroyed.method", "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"}
{
"sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"links": {
"roles": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles",
"users": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users",
"channels": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels"
},
"limits": {
"user_channels": 600,
"channel_members": 500
},
"webhooks": {
"on_member_add": {
"url": "webhooks.on_member_add.url",
"format": "webhooks.on_member_add.format",
"method": "webhooks.on_member_add.method"
},
"on_channel_add": {
"url": "webhooks.on_channel_add.url",
"format": "webhooks.on_channel_add.format",
"method": "webhooks.on_channel_add.method"
},
"on_member_added": {
"url": "webhooks.on_member_added.url",
"format": "webhooks.on_member_added.format",
"method": "webhooks.on_member_added.method"
},
"on_message_send": {
"url": "webhooks.on_message_send.url",
"format": "webhooks.on_message_send.format",
"method": "webhooks.on_message_send.method"
},
"on_message_sent": {
"url": "webhooks.on_message_sent.url",
"format": "webhooks.on_message_sent.format",
"method": "webhooks.on_message_sent.method"
},
"on_channel_added": {
"url": "webhooks.on_channel_added.url",
"format": "webhooks.on_channel_added.format",
"method": "webhooks.on_channel_added.method"
},
"on_member_remove": {
"url": "webhooks.on_member_remove.url",
"format": "webhooks.on_member_remove.format",
"method": "webhooks.on_member_remove.method"
},
"on_channel_update": {
"url": "webhooks.on_channel_update.url",
"format": "webhooks.on_channel_update.format",
"method": "webhooks.on_channel_update.method"
},
"on_member_removed": {
"url": "webhooks.on_member_removed.url",
"format": "webhooks.on_member_removed.format",
"method": "webhooks.on_member_removed.method"
},
"on_message_remove": {
"url": "webhooks.on_message_remove.url",
"format": "webhooks.on_message_remove.format",
"method": "webhooks.on_message_remove.method"
},
"on_message_update": {
"url": "webhooks.on_message_update.url",
"format": "webhooks.on_message_update.format",
"method": "webhooks.on_message_update.method"
},
"on_channel_destroy": {
"url": "webhooks.on_channel_destroy.url",
"format": "webhooks.on_channel_destroy.format",
"method": "webhooks.on_channel_destroy.method"
},
"on_channel_updated": {
"url": "webhooks.on_channel_updated.url",
"format": "webhooks.on_channel_updated.format",
"method": "webhooks.on_channel_updated.method"
},
"on_message_removed": {
"url": "webhooks.on_message_removed.url",
"format": "webhooks.on_message_removed.format",
"method": "webhooks.on_message_removed.method"
},
"on_message_updated": {
"url": "webhooks.on_message_updated.url",
"format": "webhooks.on_message_updated.format",
"method": "webhooks.on_message_updated.method"
},
"on_channel_destroyed": {
"url": "webhooks.on_channel_destroyed.url",
"format": "webhooks.on_channel_destroyed.format",
"method": "webhooks.on_channel_destroyed.method"
}
},
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"date_created": "2015-07-30T20:00:00Z",
"date_updated": "2015-07-30T20:00:00Z",
"friendly_name": "friendly_name",
"notifications": {
"new_message": {
"enabled": false,
"template": "notifications.new_message.template"
},
"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,
"default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"typing_indicator_timeout": 100,
"consumption_report_interval": 100,
"default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}