Create document

POST /v1/Services/{ServiceSid}/Documents

Sync Document objects

Path parameters

Body

  • Data

    A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.

  • Ttl integer

    How long, in seconds, before the Sync Document expires and is deleted (the Sync Document's time-to-live).

  • UniqueName string

    An application-defined string that uniquely identifies the Sync Document

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

    • created_by string | null

      The identity of the Sync Document's creator

    • data

      An arbitrary, schema-less object that the Sync Document stores

    • date_created string(date-time) | null

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

    • date_expires string(date-time) | null

      The ISO 8601 date and time in GMT when the Sync Document expires

    • date_updated string(date-time) | null

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

    • links object(uri-map) | null

      The URLs of resources related to the Sync Document

    • revision string | null

      The current revision of the Sync Document, represented by a string identifier

    • service_sid string | null

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

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

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^ET[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 Document resource
POST /v1/Services/{ServiceSid}/Documents 
curl \
 -X POST https://sync.twilio.com/v1/Services/{ServiceSid}/Documents \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Ttl=42&UniqueName=string'
Request example 
{
  "Ttl": 42,
  "UniqueName": "string"
}
Request examples 
{
  "Ttl": 42,
  "UniqueName": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "created_by": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_expires": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "links": {},
  "revision": "string",
  "service_sid": "string",
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "created_by": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_expires": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "links": {},
  "revision": "string",
  "service_sid": "string",
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com"
}