On this page

CustomerProfile Resource

CustomerProfile Properties

Resource properties

sidtype: SID<BU>

Not PII

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

Pattern:

^BU[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

account_sidtype: SID<AC>

Not PII

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

Pattern:

^AC[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

policy_sidtype: SID<RN>

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:

34

Max length:

34

friendly_nametype: string

Not PII

The string that you assigned to describe the resource.

statustype: enum<string>

Not PII

The verification status of the Customer-Profile resource.

Possible values:

draftpending-reviewin-reviewtwilio-rejectedtwilio-approved

valid_untiltype: string<date-time>

Not PII

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

emailtype: string

Not PII

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

status_callbacktype: string<uri>

Not PII

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

date_createdtype: string<date-time>

Not PII

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

date_updatedtype: string<date-time>

Not PII

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

urltype: string<uri>

Not PII

The absolute URL of the Customer-Profile resource.

linkstype: object<uri-map>

Not PII

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

Create a CustomerProfile resource

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

Parameters

Request body parameters

FriendlyNametype: stringRequired

Not PII

The string that you assigned to describe the resource.

Emailtype: stringRequired

Not PII

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

PolicySidtype: SID<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:

34

Max length:

34

StatusCallbacktype: string<uri>

Not PII

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

Create a CustomerProfile

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_14// Download the helper library from https://www.twilio.com/docs/node/install
_14// Find your Account SID and Auth Token at twilio.com/console
_14// and set the environment variables. See http://twil.io/secure
_14const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14const authToken = process.env.TWILIO_AUTH_TOKEN;
_14const client = require('twilio')(accountSid, authToken);
_14
_14client.trusthub.v1.customerProfiles
_14               .create({
_14                  friendlyName: 'friendly_name',
_14                  email: 'email',
_14                  policySid: 'RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
_14                })
_14               .then(customer_profiles => console.log(customer_profiles.sid));

Output


_19{
_19  "sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19  "policy_sid": "RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19  "friendly_name": "friendly_name",
_19  "status": "draft",
_19  "email": "email",
_19  "status_callback": "http://www.example.com",
_19  "valid_until": null,
_19  "date_created": "2019-07-30T22:29:24Z",
_19  "date_updated": "2019-07-31T01:09:00Z",
_19  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19  "links": {
_19    "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/EntityAssignments",
_19    "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Evaluations",
_19    "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments"
_19  },
_19  "errors": null
_19}

Fetch a CustomerProfile resource

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

Parameters

URI parameters

Sidtype: SID<BU>

Path ParameterNot PII

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

Pattern:

^BU[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

Fetch a CustomerProfile

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.trusthub.v1.customerProfiles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10      .fetch()
_10      .then(customer_profiles => console.log(customer_profiles.friendlyName));

Output


_23{
_23  "sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23  "policy_sid": "RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23  "friendly_name": "friendly_name",
_23  "status": "draft",
_23  "valid_until": null,
_23  "email": "email",
_23  "status_callback": "http://www.example.com",
_23  "date_created": "2019-07-30T22:29:24Z",
_23  "date_updated": "2019-07-31T01:09:00Z",
_23  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23  "links": {
_23    "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/EntityAssignments",
_23    "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Evaluations",
_23    "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments"
_23  },
_23  "errors": [
_23    {
_23      "code": 18601
_23    }
_23  ]
_23}

Read multiple CustomerProfile resources

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

Parameters

URI parameters

Statustype: enum<string>

Query ParameterNot PII

The verification status of the Customer-Profile resource.

Possible values:

draftpending-reviewin-reviewtwilio-rejectedtwilio-approved

FriendlyNametype: string

Query ParameterNot PII

The string that you assigned to describe the resource.

PolicySidtype: SID<RN>

Query ParameterNot PII

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

Pattern:

^RN[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

PageSizetype: integer

Query ParameterNot PII

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

Minimum:

1

Pagetype: integer

Query ParameterNot PII

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

Minimum:

0

PageTokentype: string

Query ParameterNot PII

The page token. This is provided by the API.

List multiple CustomerProfiles

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.trusthub.v1.customerProfiles
_10  .list({limit: 20})
_10  .then(customerProfiles => customerProfiles.forEach(c => console.log(c.sid)));

Output


_36{
_36  "results": [
_36    {
_36      "sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_36      "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_36      "policy_sid": "RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_36      "friendly_name": "friendly_name",
_36      "status": "twilio-approved",
_36      "email": "email",
_36      "status_callback": "http://www.example.com",
_36      "valid_until": "2020-07-31T01:00:00Z",
_36      "date_created": "2019-07-30T22:29:24Z",
_36      "date_updated": "2019-07-31T01:09:00Z",
_36      "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_36      "links": {
_36        "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/EntityAssignments",
_36        "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Evaluations",
_36        "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments"
_36      },
_36      "errors": [
_36        {
_36          "code": 18601
_36        }
_36      ]
_36    }
_36  ],
_36  "meta": {
_36    "page": 0,
_36    "page_size": 50,
_36    "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0",
_36    "previous_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0",
_36    "url": "https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=0",
_36    "next_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles?Status=draft&FriendlyName=friendly_name&PolicySid=RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&PageSize=50&Page=1",
_36    "key": "results"
_36  }
_36}

Update a CustomerProfile resource

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

Parameters

URI parameters

Sidtype: SID<BU>

Path ParameterNot PII

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

Pattern:

^BU[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

Request body parameters

Statustype: enum<string>

Not PII

The verification status of the Customer-Profile resource. If the current verification status of the Customer-Profile is draft, you may set the verification status to pending-review to submit the Customer-Profile for Twilio review. No other values for status are permissible when updating a resource via this API endpoint as the other states are maintained by Twilio.

Possible values:

draftpending-reviewin-reviewtwilio-rejectedtwilio-approved

StatusCallbacktype: string<uri>

Not PII

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

FriendlyNametype: string

Not PII

The string that you assigned to describe the resource.

Emailtype: string

Not PII

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

Update a CustomerProfile

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.trusthub.v1.customerProfiles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10      .update({status: 'draft'})
_10      .then(customer_profiles => console.log(customer_profiles.friendlyName));

Output


_19{
_19  "sid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19  "policy_sid": "RNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19  "friendly_name": "friendly_name",
_19  "status": "draft",
_19  "email": "email",
_19  "status_callback": "http://www.example.com",
_19  "valid_until": null,
_19  "date_created": "2019-07-30T22:29:24Z",
_19  "date_updated": "2019-07-31T01:09:00Z",
_19  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_19  "links": {
_19    "customer_profiles_entity_assignments": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/EntityAssignments",
_19    "customer_profiles_evaluations": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Evaluations",
_19    "customer_profiles_channel_endpoint_assignment": "https://trusthub.twilio.com/v1/CustomerProfiles/BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ChannelEndpointAssignments"
_19  },
_19  "errors": null
_19}

Delete a CustomerProfile resource

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

Parameters

URI parameters

Sidtype: SID<BU>

Path ParameterNot PII

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

Pattern:

^BU[0-9a-fA-F]{32}$

Min length:

34

Max length:

34

Delete a CustomerProfile

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_10// Download the helper library from https://www.twilio.com/docs/node/install
_10// Find your Account SID and Auth Token at twilio.com/console
_10// and set the environment variables. See http://twil.io/secure
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10
_10client.trusthub.v1.customerProfiles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10                  .remove();