Skip to content Skip to navigation Skip to topbar

Create a Data Mapping

(information)

Legal information

Conversation Memory, including the APIs, may use artificial intelligence or machine learning technologies and is subject to the terms of the Predictive and Generative AI/ML Features Addendum. For more details on AI usage and data, see the AI Nutrition Facts.

Conversation Memory is not a HIPAA Eligible Service or PCI compliant and should not be enabled in workflows that are subject to HIPAA or PCI.

Conversation Memory is not intended for use with sensitive information about individuals. Twilio does not control what information comes from conversation channels and relies on you to ensure the data in customer profiles aligns with our acceptable use policy. Twilio does have limited guardrails in the form of a prompt exclusion that is designed to provide a minimal screening against inclusion of GDPR special category data. As a reminder our profile technology uses generative artificial intelligence. Because generative artificial intelligence can make mistakes, review all outputs to ensure that the profile is correct.

Conversations products are only available in the new Twilio Console. If your account hasn't been migrated, you'll be redirected to the legacy Console where these products won't appear.

POST/v1/ControlPlane/Stores/{storeId}/DataMappings

Base url: https://memory.twilio.com (base url)

Create a new data mapping to connect an external data source to this Memory Store. For DATASET types, validates that all mapped Trait Groups and traits exist and that dataset field data types match their respective mapped trait data types.

Request

Authentication

Basic Auth

Path parameters

Property nameTypeRequiredPIIDescription

storeIdstring

required

A unique Memory Store ID using Twilio Type ID (TTID) format

Example: mem_store_00000000000000000000000000Pattern: ^mem_(store|service)_[0-7][0-9a-z]{25}$

Request body

Encoding type:application/json

Schema

Property nameTypeRequiredPIIDescriptionChild properties

displayNamestring

required

Name of the data mapping.

Example: crm-contactsPattern: ^[a-zA-Z][a-zA-Z0-9-_.]*$Min length: 1Max length: 128

descriptionstring

Optional

A human readable description of this resource, up to 512 characters.

Example: Syncs customer data from CRM dataset to profile traitsMin length: 1Max length: 512

isEnabledboolean

Optional

Flag indicating whether the data mapping is active. When true, data will be ingested and mapped according to the configuration. When false, the data mapping will be inactive and no data will be ingested into the Memory Store.

Default: trueExample: true

mappingTo

oneOf:

required

Details of where to map data items to. Each data mapping to type has its own set of configuration parameters and destination specific properties.

Example: {"type":"TRAITS","mappings":[{"fieldName":"primary_email","traitGroup":"Contact","traitName":"email"}]}

Show mappingTo properties

mappingFrom

oneOf:

required

Details of where to map data items from. Each data mapping from type has its own set of configuration parameters and source specific properties.

Example: {"type":"DATASET","datasetId":"tdi_dataset_00000000000000000000000000"}

Show mappingFrom properties

Responses

202400404409429500503

Data mapping creation request accepted.

Schema

Property nameTypeRequiredPIIDescriptionChild properties

messagestring

Optional

Example: Data mapping creation request accepted for processing.Max length: 512

statusUrlstring

Optional

URI to check operation status.

Max length: 512

Bad Request

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Not Found

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Conflict

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

This error indicates that you have sent too many requests to the API. You should retry according to the Retry-After response header.

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Internal Server Error

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Service Unavailable

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

codeinteger<int32>

Optional

The Twilio error code.

Minimum: 100Maximum: 99999

messagestring

Optional

A human readable message describing the error.

Max length: 1024

moreInfostring

Optional

A URL to a Twilio error directory page with more information about the error code.

statusinteger<int32>

Optional

The HTTP status code for the error.

Minimum: 100Maximum: 599

Create a Data Mapping

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 createDataMapping() {
11  const dataMapping = await client.memory.v1
12    .dataMappings("mem_store_00000000000000000000000000")
13    .create({
14      displayName: "crm-contacts",
15      mappingTo: {
16        type: "TRAITS",
17        mappings: [
18          {
19            fieldName: "fieldName",
20            expression: "expression",
21            traitGroup: "Contact",
22            traitName: "email",
23          },
24        ],
25      },
26      mappingFrom: {
27        type: "DATASET",
28        datasetId: "tdi_dataset_00000000000000000000000000",
29      },
30    });
31
32  console.log(dataMapping.message);
33}
34
35createDataMapping();

Response

1{
2  "message": "message",
3  "statusUrl": "statusUrl"
4}