Headers

• If-Match string

  The If-Match HTTP request header

Path parameters

• ServiceSid string Required

  The SID of the Sync Service with the Document resource to update.

• Sid string Required

  The SID of the Document resource to update. Can be the Document resource's sid or its unique_name.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

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

    The unique string that we created to identify the Document 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. 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_sid string | null

    The SID of the Account that created the Document resource.

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

  • service_sid string | null

    The SID of the Sync Service 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}$.

  • url string(uri) | null

    The absolute URL of the Document resource.

  • 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 as a string. The revision property is used with conditional updates to ensure data consistency.

  • data object | null

    An arbitrary, schema-less object that the Sync Document stores. Can be up to 16 KiB in length.

  • date_expires string(date-time) | null

    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_created string(date-time) | null

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

  • date_updated string(date-time) | null

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

  • created_by string | null

    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.