Skip to contentSkip to navigationSkip to topbar
Twilio Docs

Create Profile

(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(link takes you to an external page). 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(link takes you to an external page). 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(link takes you to an external page). If your account hasn't been migrated, you'll be redirected to the legacy Console where these products won't appear.

POST/v1/Stores/{storeId}/Profiles

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

Create a new profile and set initial traits. The request synchronously resolves identity and either creates a new profile ID or retrieves the associated canonical profile ID based on any provided identifier traits present in the request. The request must contain at least one trait that is promoted to an identifier in its trait group settings. Any additional traits are queued for asynchronous processing.

Request

create-profile-request page anchor

Authentication

authentication page anchor

Path parameters

create-profile-path-parameters page anchor
Property nameTypeRequiredPIIDescription
storeIdstring
required
Not PII

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

create-profile-request-body page anchor
Encoding type:application/json
SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
traitsobject

Optional

Not PII

Multiple trait groups.

Example: {"Contact":{"email":"Alyssa.Mock@example.com","phone":"+13175551234","lastName":"Mock","firstName":"Alyssa","street":"123 Main St","city":"San Francisco","state":"CA","postalCode":"94107","country":"US"}}Max properties: 50

Responses

create-profile-responses page anchor
202400401403404429500503

Profile resolved and accepted for processing.

SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
idstring

Optional

Not PII

The canonical profile ID.

Example: mem_profile_00000000000000000000000000Pattern: ^mem_profile_[0-7][0-9a-z]{25}$
messagestring

Optional

Not PII
Example: Profile resolved and accepted for processing.Max length: 255
Create ProfileLink to code sample: Create Profile
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const 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

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function createProfile() {

11
  const profile = await client.memory.v1

12
    .profiles("mem_store_00000000000000000000000000")

13
    .create({

14
      traits: {

15
        Contact: {

16
          email: "Alyssa.Mock@example.com",

17
          phone: "+13175551234",

18
          lastName: "Mock",

19
          firstName: "Alyssa",

20
          street: "123 Main St",

21
          city: "San Francisco",

22
          state: "CA",

23
          postalCode: "94107",

24
          country: "US",

25
        },

26
      },

27
    });

28


29
  console.log(profile.id);

30
}

31


32
createProfile();

Response

Note about this response
1
{

2
  "message": "Profile resolved and accepted for processing.",

3
  "id": "mem_profile_00000000000000000000000000"

4
}