Create sync map item

POST /v1/Services/{ServiceSid}/Maps/{MapSid}/Items

Keys in a sync map

Path parameters

  • ServiceSid string Required

    The SID of the Sync Service to create the Map Item in.

  • MapSid string Required

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

application/x-www-form-urlencoded

Body

  • Key string Required

    The unique, user-defined key for the Map Item. Can be up to 320 characters long.

  • Data Required

    A JSON string that represents an arbitrary, schema-less object that the Map 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 Map Item expires (time-to-live) and is deleted.

  • CollectionTtl integer

    How long, in seconds, before the Map Item's parent Sync Map 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
    • key string | null

      The unique, user-defined key for the Map Item.

    • account_sid string | null

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

    • map_sid string | null

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

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

    • url string(uri) | null

      The absolute URL of the Map Item resource.

    • revision string | null

      The current revision of the Map Item, represented as a string.

    • data object | null

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

    • date_expires string(date-time) | null

      The date and time in GMT when the Map Item expires and will be deleted, specified in ISO 8601 format. If the Map Item does not expire, this value is null. The Map Item 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 Map Item's creator. If the Map Item is created from the client SDK, the value matches the Access Token's identity field. If the Map Item was created from the REST API, the value is system.

POST /v1/Services/{ServiceSid}/Maps/{MapSid}/Items
curl \
 --request POST 'https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{MapSid}/Items' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'Key=key&Ttl=3600&Data=%7B%7D'
Request example
{"Key"=>"key", "Ttl"=>3600, "Data"=>"{}"}
Response examples (201)
{
  "key": "key",
  "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items/key",
  "data": {},
  "map_sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "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"
}