Create service

POST /v1/Services

Containers for sync objects

Body

  • AclEnabled boolean

    Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource.

  • FriendlyName string

    A string that you assign to describe the resource.

  • ReachabilityDebouncingEnabled boolean

    Whether every endpoint_disconnected event should occur after a configurable delay. The default is false, where the endpoint_disconnected event occurs immediately after disconnection. When true, intervening reconnections can prevent the endpoint_disconnected event.

  • ReachabilityDebouncingWindow integer

    The reachability event delay in milliseconds if reachability_debouncing_enabled = true. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the webhook_url is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the call to webhook_url.

  • ReachabilityWebhooksEnabled boolean

    Whether the service instance should call webhook_url when client endpoints connect to Sync. The default is false.

  • WebhookUrl string(uri)

    The URL we should call when Sync objects are manipulated.

  • WebhooksFromRestEnabled boolean

    Whether the Service instance should call webhook_url when the REST API is used to update Sync objects. The default is false.

Responses

  • 201

    Created

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

      The SID of the Account that created the resource

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

    • acl_enabled boolean | null

      Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • friendly_name string | null

      The string that you assigned to describe the resource

    • links object(uri-map) | null

      The URLs of related resources

    • reachability_debouncing_enabled boolean | null

      Whether every endpoint_disconnected event occurs after a configurable delay

    • reachability_debouncing_window integer | null

      The reachability event delay in milliseconds

    • reachability_webhooks_enabled boolean | null

      Whether the service instance calls webhook_url when client endpoints connect to Sync

    • 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}$.

    • unique_name string | null

      An application-defined string that uniquely identifies the resource

    • url string(uri) | null

      The absolute URL of the Service resource

    • webhook_url string(uri) | null

      The URL we call when Sync objects are manipulated

    • webhooks_from_rest_enabled boolean | null

      Whether the Service instance should call webhook_url when the REST API is used to update Sync objects
POST /v1/Services 
curl \
 -X POST https://sync.twilio.com/v1/Services \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'AclEnabled=true&FriendlyName=string&ReachabilityDebouncingEnabled=true&ReachabilityDebouncingWindow=42&ReachabilityWebhooksEnabled=true&WebhookUrl=https%3A%2F%2Fexample.com&WebhooksFromRestEnabled=true'
Request example 
{
  "AclEnabled": true,
  "FriendlyName": "string",
  "ReachabilityDebouncingEnabled": true,
  "ReachabilityDebouncingWindow": 42,
  "ReachabilityWebhooksEnabled": true,
  "WebhookUrl": "https://example.com",
  "WebhooksFromRestEnabled": true
}
Request examples 
{
  "AclEnabled": true,
  "FriendlyName": "string",
  "ReachabilityDebouncingEnabled": true,
  "ReachabilityDebouncingWindow": 42,
  "ReachabilityWebhooksEnabled": true,
  "WebhookUrl": "https://example.com",
  "WebhooksFromRestEnabled": true
}
Response examples (201) 
{
  "account_sid": "string",
  "acl_enabled": true,
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "links": {},
  "reachability_debouncing_enabled": true,
  "reachability_debouncing_window": 42,
  "reachability_webhooks_enabled": true,
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com",
  "webhook_url": "https://example.com",
  "webhooks_from_rest_enabled": true
}
Response examples (201) 
{
  "account_sid": "string",
  "acl_enabled": true,
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "links": {},
  "reachability_debouncing_enabled": true,
  "reachability_debouncing_window": 42,
  "reachability_webhooks_enabled": true,
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com",
  "webhook_url": "https://example.com",
  "webhooks_from_rest_enabled": true
}