Update sync list item

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

Items in a sync list

Headers

  • If-Match string

    If provided, applies this mutation if (and only if) the “revision” field of this [map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP If-Match header.

Path parameters

  • ServiceSid string Required

    The SID of the Sync Service with the Sync List Item resource to update.

  • ListSid string Required

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

  • Index integer Required

    The index of the Sync List Item resource to update.

Body

  • CollectionTtl integer

    How long, in seconds, before the List Item's parent Sync List expires (time-to-live) and is deleted. This parameter can only be used when the List Item's data or ttl is updated in the same request.

  • Data

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

  • ItemTtl integer

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

  • Ttl integer

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

Responses

  • 200

    OK

    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 List Item's creator

    • data

      An arbitrary, schema-less object that the List Item 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 List Item expires

    • date_updated string(date-time) | null

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

    • index integer | null

      The automatically generated index of the List Item

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

    • revision string | null

      The current revision of the item, represented as a string

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

    • url string(uri) | null

      The absolute URL of the List Item resource
POST /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index} 
curl \
 -X POST https://sync.twilio.com/v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -H "If-Match: string" \
 -d 'CollectionTtl=42&ItemTtl=42&Ttl=42'
Request example 
# Headers
If-Match: string

# Payload
{
  "CollectionTtl": 42,
  "ItemTtl": 42,
  "Ttl": 42
}
Request examples 
# Headers
If-Match: string

# Payload
{
  "CollectionTtl": 42,
  "ItemTtl": 42,
  "Ttl": 42
}
Response examples (200) 
{
  "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",
  "index": 42,
  "list_sid": "string",
  "revision": "string",
  "service_sid": "string",
  "url": "https://example.com"
}
Response examples (200) 
{
  "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",
  "index": 42,
  "list_sid": "string",
  "revision": "string",
  "service_sid": "string",
  "url": "https://example.com"
}