Twilio Sync API is a real-time data synchronization service that allows developers to easily build and maintain collaborative applications. By providing a secure and reliable way to sync data across multiple devices and platforms, Twilio Sync API enables developers to create seamless user experiences, seamless user experiences where changes made on one device are instantly reflected on all other connected devices.
components:
schemas:
sync.v1.service.document:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ET[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Document resource.
unique_name:
type: string
nullable: true
description: >-
An application-defined string that uniquely identifies the resource.
It can be used in place of the resource's `sid` in the URL to
address the resource and can be up to 320 characters long.
x-twilio:
pii:
handling: standard
deleteSla: 30
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Document resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the [Sync
Service](https://www.twilio.com/docs/sync/api/service) the resource
is associated with.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Document resource.
links:
type: object
format: uri-map
nullable: true
description: The URLs of resources related to the Sync Document.
revision:
type: string
nullable: true
description: >-
The current revision of the Sync Document, represented as a string.
The `revision` property is used with conditional updates to ensure
data consistency.
data:
nullable: true
description: >-
An arbitrary, schema-less object that the Sync Document stores. Can
be up to 16 KiB in length.
x-twilio:
pii:
handling: sensitive
deleteSla: 7
date_expires:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Sync Document expires and will be
deleted, specified in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync
Document does not expire, this value is `null`. The Document
resource might not be deleted immediately after it expires.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
created_by:
type: string
nullable: true
description: >-
The identity of the Sync Document's creator. If the Sync Document is
created from the client SDK, the value matches the Access Token's
`identity` field. If the Sync Document was created from the REST
API, the value is `system`.
x-twilio:
pii:
handling: standard
deleteSla: 30
sync.v1.service.document.document_permission:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Document Permission resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the [Sync
Service](https://www.twilio.com/docs/sync/api/service) the resource
is associated with.
document_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ET[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Sync Document to which the Document Permission
applies.
identity:
type: string
nullable: true
description: >-
The application-defined string that uniquely identifies the
resource's User within the Service to an FPA token.
x-twilio:
pii:
handling: standard
deleteSla: 30
read:
type: boolean
nullable: true
description: Whether the identity can read the Sync Document.
write:
type: boolean
nullable: true
description: Whether the identity can update the Sync Document.
manage:
type: boolean
nullable: true
description: Whether the identity can delete the Sync Document.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Sync Document Permission resource.
sync.v1.service:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Service resource.
unique_name:
type: string
nullable: true
description: >-
An application-defined string that uniquely identifies the resource.
It can be used in place of the resource's `sid` in the URL to
address the resource. It is a read-only property, it cannot be
assigned using REST API.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Service resource.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the resource.
x-twilio:
pii:
handling: standard
deleteSla: 7
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Service resource.
webhook_url:
type: string
format: uri
nullable: true
description: The URL we call when Sync objects are manipulated.
webhooks_from_rest_enabled:
type: boolean
nullable: true
description: >-
Whether the Service instance should call `webhook_url` when the REST
API is used to update Sync objects. The default is `false`.
reachability_webhooks_enabled:
type: boolean
nullable: true
description: >-
Whether the service instance calls `webhook_url` when client
endpoints connect to Sync. The default is `false`.
acl_enabled:
type: boolean
nullable: true
description: >-
Whether token identities in the Service must be granted access to
Sync objects by using the
[Permissions](https://www.twilio.com/docs/sync/api/sync-permissions)
resource. It is disabled (false) by default.
reachability_debouncing_enabled:
type: boolean
nullable: true
description: >-
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.
reachability_debouncing_window:
type: integer
nullable: true
description: >-
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 `webhook_url` is called, if all endpoints
remain offline. A reconnection from the same identity by any
endpoint during this interval prevents the reachability event from
occurring.
links:
type: object
format: uri-map
nullable: true
description: The URLs of related resources.
sync.v1.service.sync_stream.stream_message:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^TZ[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Stream Message
resource.
data:
nullable: true
description: >-
An arbitrary, schema-less object that contains the Stream Message
body. Can be up to 4 KiB in length.
x-twilio:
pii:
handling: sensitive
deleteSla: 0
sync.v1.service.sync_list:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ES[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Sync List
resource.
unique_name:
type: string
nullable: true
description: >-
An application-defined string that uniquely identifies the resource.
It can be used in place of the resource's `sid` in the URL to
address the resource.
x-twilio:
pii:
handling: standard
deleteSla: 30
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Sync List resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the [Sync
Service](https://www.twilio.com/docs/sync/api/service) the resource
is associated with.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Sync List resource.
links:
type: object
format: uri-map
nullable: true
description: The URLs of the Sync List's nested resources.
revision:
type: string
nullable: true
description: The current revision of the Sync List, represented as a string.
date_expires:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Sync List expires and will be
deleted, specified in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync
List does not expire, this value is `null`. The Sync List might not
be deleted immediately after it expires.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
created_by:
type: string
nullable: true
description: >-
The identity of the Sync List's creator. If the Sync List is created
from the client SDK, the value matches the Access Token's `identity`
field. If the Sync List was created from the REST API, the value is
`system`.
x-twilio:
pii:
handling: standard
deleteSla: 30
sync.v1.service.sync_list.sync_list_item:
type: object
properties:
index:
type: integer
nullable: true
description: >-
The automatically generated index of the List Item. The `index`
values of the List Items in a Sync List can have gaps in their
sequence.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the List Item resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the [Sync
Service](https://www.twilio.com/docs/sync/api/service) the resource
is associated with.
list_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ES[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Sync List that contains the List Item.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the List Item resource.
revision:
type: string
nullable: true
description: The current revision of the item, represented as a string.
data:
nullable: true
description: >-
An arbitrary, schema-less object that the List Item stores. Can be
up to 16 KiB in length.
x-twilio:
pii:
handling: sensitive
deleteSla: 7
date_expires:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the List Item expires and will be
deleted, specified in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the List
Item does not expire, this value is `null`. The List Item resource
might not be deleted immediately after it expires.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
created_by:
type: string
nullable: true
description: >-
The identity of the List Item's creator. If the item is created from
the client SDK, the value matches the Access Token's `identity`
field. If the item was created from the REST API, the value is
`system`.
x-twilio:
pii:
handling: standard
deleteSla: 30
sync_list_item_enum_query_result_order:
type: string
enum:
- asc
- desc
sync_list_item_enum_query_from_bound_type:
type: string
enum:
- inclusive
- exclusive
sync.v1.service.sync_list.sync_list_permission:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Sync List Permission resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the [Sync
Service](https://www.twilio.com/docs/sync/api/service) the resource
is associated with.
list_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^ES[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Sync List to which the Permission applies.
identity:
type: string
nullable: true
description: >-
The application-defined string that uniquely identifies the
resource's User within the Service to an FPA token.
x-twilio:
pii:
handling: standard
deleteSla: 30
read:
type: boolean
nullable: true
description: Whether the identity can read the Sync List and its Items.
write:
type: boolean
nullable: true
description: >-
Whether the identity can create, update, and delete Items in the
Sync List.
manage:
type: boolean
nullable: true
description: Whether the identity can delete the Sync List.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Sync List Permission resource.
sync.v1.service.sync_map:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^MP[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Sync Map resource.
unique_name:
type: string
nullable: true
description: >-
An application-defined string that uniquely identifies the resource.
It can be used in place of the resource's `sid` in the URL to
address the resource.
x-twilio:
pii:
handling: standard
deleteSla: 30
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Sync Map resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the [Sync
Service](https://www.twilio.com/docs/sync/api/service) the resource
is associated with.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Sync Map resource.
links:
type: object
format: uri-map
nullable: true
description: The URLs of the Sync Map's nested resources.
revision:
type: string
nullable: true
description: The current revision of the Sync Map, represented as a string.
date_expires:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Sync Map expires and will be
deleted, specified in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync
Map does not expire, this value is `null`. The Sync Map might not be
deleted immediately after it expires.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
created_by:
type: string
nullable: true
description: >-
The identity of the Sync Map's creator. If the Sync Map is created
from the client SDK, the value matches the Access Token's `identity`
field. If the Sync Map was created from the REST API, the value is
`system`.
x-twilio:
pii:
handling: standard
deleteSla: 30
sync.v1.service.sync_map.sync_map_item:
type: object
properties:
key:
type: string
nullable: true
description: The unique, user-defined key for the Map Item.
x-twilio:
pii:
handling: standard
deleteSla: 30
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Map Item resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the [Sync
Service](https://www.twilio.com/docs/sync/api/service) the resource
is associated with.
map_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^MP[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Sync Map that contains the Map Item.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Map Item resource.
revision:
type: string
nullable: true
description: The current revision of the Map Item, represented as a string.
data:
nullable: true
description: >-
An arbitrary, schema-less object that the Map Item stores. Can be up
to 16 KiB in length.
x-twilio:
pii:
handling: sensitive
deleteSla: 7
date_expires:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Map Item expires and will be
deleted, specified in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Map
Item does not expire, this value is `null`. The Map Item might not
be deleted immediately after it expires.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
created_by:
type: string
nullable: true
description: >-
The identity of the Map Item's creator. If the Map Item is created
from the client SDK, the value matches the Access Token's `identity`
field. If the Map Item was created from the REST API, the value is
`system`.
x-twilio:
pii:
handling: standard
deleteSla: 30
sync_map_item_enum_query_result_order:
type: string
enum:
- asc
- desc
sync_map_item_enum_query_from_bound_type:
type: string
enum:
- inclusive
- exclusive
sync.v1.service.sync_map.sync_map_permission:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Sync Map Permission resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the [Sync
Service](https://www.twilio.com/docs/sync/api/service) the resource
is associated with.
map_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^MP[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Sync Map to which the Permission applies.
identity:
type: string
nullable: true
description: >-
The application-defined string that uniquely identifies the
resource's User within the Service to an FPA token.
x-twilio:
pii:
handling: standard
deleteSla: 30
read:
type: boolean
nullable: true
description: Whether the identity can read the Sync Map and its Items.
write:
type: boolean
nullable: true
description: >-
Whether the identity can create, update, and delete Items in the
Sync Map.
manage:
type: boolean
nullable: true
description: Whether the identity can delete the Sync Map.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Sync Map Permission resource.
sync.v1.service.sync_stream:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^TO[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Sync Stream
resource.
unique_name:
type: string
nullable: true
description: >-
An application-defined string that uniquely identifies the resource.
It can be used in place of the resource's `sid` in the URL to
address the resource.
x-twilio:
pii:
handling: standard
deleteSla: 30
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Sync Stream resource.
service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the [Sync
Service](https://www.twilio.com/docs/sync/api/service) the resource
is associated with.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Message Stream resource.
links:
type: object
format: uri-map
nullable: true
description: The URLs of the Stream's nested resources.
date_expires:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Message Stream expires and will be
deleted, specified in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Message
Stream does not expire, this value is `null`. The Stream might not
be deleted immediately after it expires.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
created_by:
type: string
nullable: true
description: >-
The identity of the Stream's creator. If the Stream is created from
the client SDK, the value matches the Access Token's `identity`
field. If the Stream was created from the REST API, the value is
'system'.
x-twilio:
pii:
handling: standard
deleteSla: 30
UpdateDocumentRequest:
type: object
properties:
Data:
description: >-
A JSON string that represents an arbitrary, schema-less object that
the Sync Document stores. Can be up to 16 KiB in length.
Ttl:
type: integer
description: >-
How long, [in
seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits),
before the Sync Document expires and is deleted (time-to-live).
CreateDocumentRequest:
type: object
properties:
UniqueName:
type: string
description: >-
An application-defined string that uniquely identifies the Sync
Document
Data:
description: >-
A JSON string that represents an arbitrary, schema-less object that
the Sync Document stores. Can be up to 16 KiB in length.
Ttl:
type: integer
description: >-
How long, [in
seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits),
before the Sync Document expires and is deleted (the Sync Document's
time-to-live).
ListDocumentResponse:
type: object
properties:
documents:
type: array
items:
$ref: '#/components/schemas/sync.v1.service.document'
meta:
type: object
properties:
first_page_url:
type: string
format: uri
next_page_url:
type: string
format: uri
nulla
# --- truncated at 32 KB (122 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/openapi/sync-openapi-original.yml