CustomerProfile Resource

CustomerProfile Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<BU>

Optional

Not PII

The unique string that we created to identify the Customer-Profile resource.

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

accountSidSID<AC>

Optional

Not PII

The SID of the Account that created the Customer-Profile resource.

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

policySidSID<RN>

Optional

Not PII

The unique string of a policy that is associated to the Customer-Profile resource.

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

friendlyNamestring

Optional

Not PII

The string that you assigned to describe the resource.

statusenum<string>

Optional

Not PII

The verification status of the Customer-Profile resource.

Possible values:

draftpending-reviewin-reviewtwilio-rejectedtwilio-approved

validUntilstring<date-time>

Optional

Not PII

The date and time in GMT in ISO 8601 format when the resource will be valid until.

emailstring

Optional

Not PII

The email address that will receive updates when the Customer-Profile resource changes status.

statusCallbackstring<uri>

Optional

Not PII

The URL we call to inform your application of status changes.

dateCreatedstring<date-time>

Optional

Not PII

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

dateUpdatedstring<date-time>

Optional

Not PII

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

urlstring<uri>

Optional

Not PII

The absolute URL of the Customer-Profile resource.

linksobject<uri-map>

Optional

Not PII

The URLs of the Assigned Items of the Customer-Profile resource.

errorsarray[object]

Optional

Not PII

The error codes associated with the rejection of the Customer-Profile.

Create a CustomerProfile resource

POST https://trusthub.twilio.com/v1/CustomerProfiles

Request body parameters

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

SchemaExample

Property nameTypeRequiredDescriptionChild properties

friendlyNamestring

required

Not PII

The string that you assigned to describe the resource.

emailstring

required

Not PII

The email address that will receive updates when the Customer-Profile resource changes status.

policySidSID<RN>

required

Not PII

The unique string of a policy that is associated to the Customer-Profile resource.

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

statusCallbackstring<uri>

Optional

Not PII

The URL we call to inform your application of status changes.

Create a CustomerProfile

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 createCustomerProfile() {
11  const customerProfile = await client.trusthub.v1.customerProfiles.create({
12    email: "Email",
13    friendlyName: "FriendlyName",
14    policySid: "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15  });
16
17  console.log(customerProfile.sid);
18}
19
20createCustomerProfile();

Response

1{
2  "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "friendly_name": "FriendlyName",
6  "status": "draft",
7  "email": "Email",
8  "status_callback": "http://www.example.com",
9  "valid_until": null,
10  "date_created": "2019-07-30T22:29:24Z",
11  "date_updated": "2019-07-31T01:09:00Z",
12  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "links": {
14    "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments",
15    "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations",
16    "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments"
17  },
18  "errors": null
19}

Fetch a CustomerProfile resource

GET https://trusthub.twilio.com/v1/CustomerProfiles/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

sidSID<BU>

required

Not PII

The unique string that we created to identify the Customer-Profile resource.

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

Fetch a CustomerProfile

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 fetchCustomerProfile() {
11  const customerProfile = await client.trusthub.v1
12    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .fetch();
14
15  console.log(customerProfile.sid);
16}
17
18fetchCustomerProfile();

Response

1{
2  "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "friendly_name": "friendly_name",
6  "status": "draft",
7  "valid_until": null,
8  "email": "email",
9  "status_callback": "http://www.example.com",
10  "date_created": "2019-07-30T22:29:24Z",
11  "date_updated": "2019-07-31T01:09:00Z",
12  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "links": {
14    "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments",
15    "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations",
16    "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments"
17  },
18  "errors": [
19    {
20      "code": 18601
21    }
22  ]
23}

Read multiple CustomerProfile resources

GET https://trusthub.twilio.com/v1/CustomerProfiles

Query parameters

Property nameTypeRequiredPIIDescription

statusenum<string>

Optional

Not PII

The verification status of the Customer-Profile resource.

Possible values:

draftpending-reviewin-reviewtwilio-rejectedtwilio-approved

friendlyNamestring

Optional

Not PII

The string that you assigned to describe the resource.

policySidSID<RN>

Optional

Not PII

The unique string of a policy that is associated to the Customer-Profile resource.

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

pageSizeinteger<int64>

Optional

Not PII

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

Minimum: 1Maximum: 1000

pageinteger

Optional

Not PII

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

Minimum: 0

pageTokenstring

Optional

Not PII

The page token. This is provided by the API.

List multiple CustomerProfiles

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 listCustomerProfile() {
11  const customerProfiles = await client.trusthub.v1.customerProfiles.list({
12    limit: 20,
13  });
14
15  customerProfiles.forEach((c) => console.log(c.sid));
16}
17
18listCustomerProfile();

Response

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

Update a CustomerProfile resource

POST https://trusthub.twilio.com/v1/CustomerProfiles/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

sidSID<BU>

required

Not PII

The unique string that we created to identify the Customer-Profile resource.

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

Request body parameters

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

SchemaExample

Property nameTypeRequiredDescriptionChild properties

statusenum<string>

Optional

Not PII

The verification status of the Customer-Profile resource.

Possible values:

draftpending-reviewin-reviewtwilio-rejectedtwilio-approved

statusCallbackstring<uri>

Optional

Not PII

The URL we call to inform your application of status changes.

friendlyNamestring

Optional

Not PII

The string that you assigned to describe the resource.

emailstring

Optional

Not PII

The email address that will receive updates when the Customer-Profile resource changes status.

Update a CustomerProfile

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 updateCustomerProfile() {
11  const customerProfile = await client.trusthub.v1
12    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .update({ status: "draft" });
14
15  console.log(customerProfile.sid);
16}
17
18updateCustomerProfile();

Response

1{
2  "sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "policy_sid": "RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "friendly_name": "friendly_name",
6  "status": "draft",
7  "email": "email",
8  "status_callback": "http://www.example.com",
9  "valid_until": null,
10  "date_created": "2019-07-30T22:29:24Z",
11  "date_updated": "2019-07-31T01:09:00Z",
12  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "links": {
14    "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/EntityAssignments",
15    "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Evaluations",
16    "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments"
17  },
18  "errors": null
19}

Delete a CustomerProfile resource

DELETE https://trusthub.twilio.com/v1/CustomerProfiles/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

sidSID<BU>

required

Not PII

The unique string that we created to identify the Customer-Profile resource.

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

Delete a CustomerProfile

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 deleteCustomerProfile() {
11  await client.trusthub.v1
12    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .remove();
14}
15
16deleteCustomerProfile();