Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

CustomerProfile Resource



CustomerProfile Properties

customerprofile-properties page anchor
Resource properties
sidtype: SID<BU>Not PII

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


policy_sidtype: SID<RN>Not PII

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


friendly_nametype: stringNot 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(link takes you to an external page) format when the resource will be valid until.


emailtype: stringNot 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(link takes you to an external page) format.


date_updatedtype: string<DATE TIME>Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601(link takes you to an external page) 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

create-a-customerprofile-resource page anchor
POST https://trusthub.twilio.com/v1/CustomerProfiles

Parameters

create-parameters page anchor
Request body parameters
FriendlyNametype: stringNot PII
Required

The string that you assigned to describe the resource.


Emailtype: stringNot PII
Required

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


PolicySidtype: SID<RN>Not PII
Required

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


StatusCallbacktype: string<URI>Not PII

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

Create a CustomerProfile

create-a-customerprofile page anchor
Node.js
Python
C#
Java
Go
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
_14
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14
const authToken = process.env.TWILIO_AUTH_TOKEN;
_14
const client = require('twilio')(accountSid, authToken);
_14
_14
client.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

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


Fetch a CustomerProfile resource

fetch-a-customerprofile-resource page anchor
GET https://trusthub.twilio.com/v1/CustomerProfiles/{Sid}

URI parameters
Sidtype: SID<BU>Not PII
Path Parameter

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

Node.js
Python
C#
Java
Go
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
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.customerProfiles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.fetch()
_10
.then(customer_profiles => console.log(customer_profiles.friendlyName));

Output

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


Read multiple CustomerProfile resources

read-multiple-customerprofile-resources page anchor
GET https://trusthub.twilio.com/v1/CustomerProfiles

URI parameters
Statustype: enum<STRING>Not PII
Query Parameter

The verification status of the Customer-Profile resource.

Possible values:
draftpending-reviewin-reviewtwilio-rejectedtwilio-approved

FriendlyNametype: stringNot PII
Query Parameter

The string that you assigned to describe the resource.


PolicySidtype: SID<RN>Not PII
Query Parameter

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


PageSizetype: integerNot PII
Query Parameter

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


Pagetype: integerNot PII
Query Parameter

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


PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

List multiple CustomerProfiles

list-multiple-customerprofiles page anchor
Node.js
Python
C#
Java
Go
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
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.customerProfiles
_10
.list({limit: 20})
_10
.then(customerProfiles => customerProfiles.forEach(c => console.log(c.sid)));

Output

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


Update a CustomerProfile resource

update-a-customerprofile-resource page anchor
POST https://trusthub.twilio.com/v1/CustomerProfiles/{Sid}

URI parameters
Sidtype: SID<BU>Not PII
Path Parameter

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


Request body parameters
Statustype: enum<STRING>Not PII

The verification status of the Customer-Profile resource.

Possible values:
draftpending-reviewin-reviewtwilio-rejectedtwilio-approved

StatusCallbacktype: string<URI>Not PII

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


FriendlyNametype: stringNot PII

The string that you assigned to describe the resource.


Emailtype: stringNot PII

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

Update a CustomerProfile

update-a-customerprofile page anchor
Node.js
Python
C#
Java
Go
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
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.customerProfiles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.update({status: 'draft'})
_10
.then(customer_profiles => console.log(customer_profiles.friendlyName));

Output

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


Delete a CustomerProfile resource

delete-a-customerprofile-resource page anchor
DELETE https://trusthub.twilio.com/v1/CustomerProfiles/{Sid}

URI parameters
Sidtype: SID<BU>Not PII
Path Parameter

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

Delete a CustomerProfile

delete-a-customerprofile page anchor
Node.js
Python
C#
Java
Go
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
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.trusthub.v1.customerProfiles('BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.remove();


Rate this page: