Update service

POST /v2/Services/{Sid}

Path parameters

  • Sid string Required

    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
  • DefaultServiceRoleSid string

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

  • DefaultChannelRoleSid string

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

  • DefaultChannelCreatorRoleSid string

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

  • ReadStatusEnabled boolean
  • ReachabilityEnabled boolean
  • TypingIndicatorTimeout integer
  • ConsumptionReportInterval integer
  • Notifications.NewMessage.Enabled boolean
  • Notifications.NewMessage.Template string
  • Notifications.NewMessage.Sound string
  • Notifications.NewMessage.BadgeCountEnabled boolean
  • Notifications.AddedToChannel.Enabled boolean
  • Notifications.AddedToChannel.Template string
  • Notifications.AddedToChannel.Sound string
  • Notifications.RemovedFromChannel.Enabled boolean
  • Notifications.RemovedFromChannel.Template string
  • Notifications.RemovedFromChannel.Sound string
  • Notifications.InvitedToChannel.Enabled boolean
  • Notifications.InvitedToChannel.Template string
  • Notifications.InvitedToChannel.Sound string
  • PreWebhookUrl string(uri)
  • PostWebhookUrl string(uri)
  • WebhookMethod string(http-method)

    Values are GET or POST.

  • WebhookFilters array[string]
  • Limits.ChannelMembers integer
  • Limits.UserChannels integer
  • Media.CompatibilityMessage string
  • PreWebhookRetryCount integer
  • PostWebhookRetryCount integer
  • Notifications.LogEnabled boolean

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

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

    • account_sid string | null

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

    • friendly_name string | null
    • date_created string(date-time) | null
    • date_updated string(date-time) | null
    • default_service_role_sid string | null

      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

      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

      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
    • reachability_enabled boolean | null
    • typing_indicator_timeout integer

      Default value is 0.

    • consumption_report_interval integer

      Default value is 0.

    • limits
    • pre_webhook_url string | null
    • post_webhook_url string | null
    • webhook_method string | null
    • webhook_filters array[string] | null
    • pre_webhook_retry_count integer

      Default value is 0.

    • post_webhook_retry_count integer

      Default value is 0.

    • notifications
    • media
    • url string(uri) | null
POST /v2/Services/{Sid}
curl \
 --request POST 'https://ip-messaging.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://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "roles": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles",
    "users": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users",
    "bindings": "https://ip-messaging.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings",
    "channels": "https://ip-messaging.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"
}