Create sync list item

POST /v1/Services/{ServiceSid}/Lists/{ListSid}/Items

Items in a sync list

Path parameters

  • ServiceSid string Required

    The SID of the Sync Service to create the new List Item in.

  • ListSid string Required

    The SID of the Sync List to add the new List Item to. Can be the Sync List resource's sid or its unique_name.

application/x-www-form-urlencoded

Body

  • Data Required

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

  • Ttl integer

    An alias for item_ttl. If both parameters are provided, this value is ignored.

  • ItemTtl integer

    How long, in seconds, before the List Item expires (time-to-live) and is deleted.

  • CollectionTtl integer

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

Responses

  • 201 application/json

    Created

    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
    • index integer

      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.

      Default value is 0.

    • account_sid string | null

      The SID of the Account that created the List Item 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}$.

    • list_sid string | null

      The SID of the Sync List that contains the List Item.

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

    • url string(uri) | null

      The absolute URL of the List Item resource.

    • revision string | null

      The current revision of the item, represented as a string.

    • data object | null

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

    • date_expires string(date-time) | null

      The date and time in GMT when the List Item expires and will be deleted, specified in 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 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 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.

POST /v1/Services/{ServiceSid}/Lists/{ListSid}/Items
curl \
 --request POST 'https://sync.twilio.com/v1/Services/{ServiceSid}/Lists/{ListSid}/Items' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Ttl=3600&Data=%7B%7D'
Request example
{"Ttl"=>3600, "Data"=>"{}"}
Response examples (201)
{
  "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Lists/ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/100",
  "data": {},
  "index": 100,
  "list_sid": "ESaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "revision": "revision",
  "created_by": "created_by",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2015-07-30T20:00:00Z",
  "date_expires": "2015-07-30T21:00:00Z",
  "date_updated": "2015-07-30T20:00:00Z"
}