Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-054815267.9 KB
SyncV1Document

post/v1/Services/{ServiceSid}/Documents

Path parameters

ServiceSidstring required

The SID of the Sync Service to create the new Document resource in.

Response

Created

sidstring nullable

The unique string that we created to identify the Document resource.

unique_namestring nullable

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.

account_sidstring nullable

The SID of the Account that created the Document resource.

service_sidstring nullable

The SID of the Sync Service the resource is associated with.

urlstring uri nullable

The absolute URL of the Document resource.

linksobject nullable

The URLs of resources related to the Sync Document.

revisionstring nullable

The current revision of the Sync Document, represented as a string. The revision property is used with conditional updates to ensure data consistency.

{"stackTrail":"components:schemas:sync.v1.service.document:properties:data","oasType":"schema","type":"unknown","description":"An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.","extensionFields":{"x-twilio":{"pii":{"handling":"sensitive","deleteSla":7}}},"nullable":true}
date_expiresstring date-time nullable

The date and time in GMT when the Sync Document expires and will be deleted, specified in 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_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

created_bystring nullable

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.