Skip to content Skip to navigation Skip to topbar

On this page

Map Resource

A Sync Map stores unordered JSON objects accessible via a developer-defined key. It is an unordered collection of individual Map items.

After you create a Map, use the MapItem resource to add, retrieve, update, and delete items from your Map.

A few notes about Sync Maps:

Full map modification history persists with every change that triggers a new revision.
Strict ordering of map mutation events is guaranteed, but the map item order is not defined.
By default, data persists permanently, but maps will expire and be deleted automatically if eviction is configured via the TTL parameter.

Maps can be created, updated, subscribed to and removed via the client JavaScript SDK. Servers wishing to manage these objects can do so via the REST API.

Map properties

Each Map object root resource has the following properties.

Unique name and expiration date attributes are optional and may be null.

Property nameTypeRequiredDescriptionChild properties

sidSID<MP>Optional

Not PII

The unique string that we created to identify the Sync Map resource.

Pattern: ^MP[0-9a-fA-F]{32}$Min length: 34Max length: 34

unique_namestringOptional

PII MTL: 30 days

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.

account_sidSID<AC>Optional

Not PII

The SID of the Account that created the Sync Map resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

service_sidSID<IS>Optional

Not PII

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

Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34

urlstring<uri>Optional

Not PII

The absolute URL of the Sync Map resource.

linksobject<uri-map>Optional

Not PII

The URLs of the Sync Map's nested resources.

revisionstringOptional

Not PII

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

date_expiresstring<date-time>Optional

Not PII

The date and time in GMT when the Sync Map expires and will be deleted, specified in ISO 8601 format. If the Sync Map does not expire, this value is null. The Sync Map might not be deleted immediately after it expires.

date_createdstring<date-time>Optional

Not PII

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

date_updatedstring<date-time>Optional

Not PII

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

created_bystringOptional

PII MTL: 30 days

The identity of the Sync Map's creator. If the Sync Map is created from the client SDK, the value matches the Access Token's identity field. If the Sync Map was created from the REST API, the value is system.

Create a SyncMap resource

POST https://sync.twilio.com/v1/Services/{ServiceSid}/Maps

Create a new Map in this Service Instance, optionally giving it a unique name and assigning an expiration deadline.

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

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

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

UniqueNamestringOptional

PII MTL: 30 days

An application-defined string that uniquely identifies the resource. It can be used as an alternative to the sid in the URL path to address the resource.

TtlintegerOptional

Not PII

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

CollectionTtlintegerOptional

Not PII

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

Create a Map

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createSyncMap() {
11  const syncMap = await client.sync.v1.services("ServiceSid").syncMaps.create();
12
13  console.log(syncMap.sid);
14}
15
16createSyncMap();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "created_by": "created_by",
4  "date_expires": "2015-07-30T21:00:00Z",
5  "date_created": "2015-07-30T20:00:00Z",
6  "date_updated": "2015-07-30T20:00:00Z",
7  "links": {
8    "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items",
9    "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions"
10  },
11  "revision": "revision",
12  "service_sid": "ServiceSid",
13  "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14  "unique_name": "unique_name",
15  "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
16}

Create a Map with a unique name

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createSyncMap() {
11  const syncMap = await client.sync.v1
12    .services("ServiceSid")
13    .syncMaps.create({ uniqueName: "my_first_map" });
14
15  console.log(syncMap.sid);
16}
17
18createSyncMap();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "created_by": "created_by",
4  "date_expires": "2015-07-30T21:00:00Z",
5  "date_created": "2015-07-30T20:00:00Z",
6  "date_updated": "2015-07-30T20:00:00Z",
7  "links": {
8    "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items",
9    "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions"
10  },
11  "revision": "revision",
12  "service_sid": "ServiceSid",
13  "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14  "unique_name": "my_first_map",
15  "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
16}

Create a Map with an expiration deadline

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createSyncMap() {
11  const syncMap = await client.sync.v1
12    .services("ServiceSid")
13    .syncMaps.create({ ttl: 600 });
14
15  console.log(syncMap.sid);
16}
17
18createSyncMap();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "created_by": "created_by",
4  "date_expires": "2015-07-30T21:00:00Z",
5  "date_created": "2015-07-30T20:00:00Z",
6  "date_updated": "2015-07-30T20:00:00Z",
7  "links": {
8    "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items",
9    "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions"
10  },
11  "revision": "revision",
12  "service_sid": "ServiceSid",
13  "sid": "MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14  "unique_name": "unique_name",
15  "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
16}

Fetch a SyncMap resource

GET https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Sync Service with the Sync Map resource to fetch.

Sidstringrequired

Not PII

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

Fetch a Map

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchSyncMap() {
11  const syncMap = await client.sync.v1
12    .services("ServiceSid")
13    .syncMaps("Sid")
14    .fetch();
15
16  console.log(syncMap.sid);
17}
18
19fetchSyncMap();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "created_by": "created_by",
4  "date_expires": "2015-07-30T21:00:00Z",
5  "date_created": "2015-07-30T20:00:00Z",
6  "date_updated": "2015-07-30T20:00:00Z",
7  "links": {
8    "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items",
9    "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions"
10  },
11  "revision": "revision",
12  "service_sid": "ServiceSid",
13  "sid": "Sid",
14  "unique_name": "unique_name",
15  "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
16}

Read multiple SyncMap resources

GET https://sync.twilio.com/v1/Services/{ServiceSid}/Maps

Retrieve a list of all Maps belonging to this Service Instance.

(information)

Info

By default, this will return the first 50 Maps. Supply a PageSize parameter to fetch up to 100 items at once. See paging for more information.

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Sync Service with the Sync Map resources to read.

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

List multiple Maps

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listSyncMap() {
11  const syncMaps = await client.sync.v1
12    .services("ServiceSid")
13    .syncMaps.list({ limit: 20 });
14
15  syncMaps.forEach((s) => console.log(s.sid));
16}
17
18listSyncMap();

Output

1{
2  "maps": [],
3  "meta": {
4    "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0",
5    "key": "maps",
6    "next_page_url": null,
7    "page": 0,
8    "page_size": 50,
9    "previous_page_url": null,
10    "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps?PageSize=50&Page=0"
11  }
12}

Update a SyncMap resource

POST https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

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

Sidstringrequired

Not PII

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

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

TtlintegerOptional

Not PII

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

CollectionTtlintegerOptional

Not PII

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

Update a Map

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateSyncMap() {
11  const syncMap = await client.sync.v1
12    .services("ServiceSid")
13    .syncMaps("Sid")
14    .update({ ttl: 42 });
15
16  console.log(syncMap.sid);
17}
18
19updateSyncMap();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "created_by": "created_by",
4  "date_expires": "2015-07-30T21:00:00Z",
5  "date_created": "2015-07-30T20:00:00Z",
6  "date_updated": "2015-07-30T20:00:00Z",
7  "links": {
8    "items": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Items",
9    "permissions": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions"
10  },
11  "revision": "revision",
12  "service_sid": "ServiceSid",
13  "sid": "Sid",
14  "unique_name": "unique_name",
15  "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Maps/MPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
16}

Delete a Sync Map resource

DELETE https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{Sid}

Permanently delete a specific Map along with all items belonging to it from a given Sync Service Instance.

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Sync Service with the Sync Map resource to delete.

Sidstringrequired

Not PII

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

Delete a Map with the REST API

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function deleteSyncMap() {
11  await client.sync.v1.services("ServiceSid").syncMaps("Sid").remove();
12}
13
14deleteSyncMap();

Delete a Map with the JavaScript SDK

1syncClient.map('users').then(function (map) {
2  map.removeMap().then(function () {
3    console.log('map deleted');
4  });
5});