SyncV1SyncListItem

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

Request

  • Base URL
    https://sync.twilio.com
  • URL
    https://sync.twilio.com/v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}
  • Auth
    HTTP basic

Path parameters

ServiceSidstring required

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

ListSidstring 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.

Indexinteger required

The index of the Sync List Item resource to update.

Headers

If-Matchstring

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.

Request body application/x-www-form-urlencoded

Dataunknown
Ttlinteger

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

ItemTtlinteger

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

CollectionTtlinteger

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.

Response

OK

indexinteger

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.

account_sidstring nullable

The SID of the Account that created the List Item resource.

service_sidstring nullable

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

list_sidstring nullable

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

urlstring uri nullable

The absolute URL of the List Item resource.

revisionstring nullable

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

dataunknown
date_expiresstring date-time nullable

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_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 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.

Changes

Changes to this operation have not been checked yet.