On this page

CustomerProfileChannelEndpointAssignment Resource

CustomerProfileChannelEndpointAssignment Properties

Property nameTypePIIDescription

sidSID<RA>

Not PII

The unique string that we created to identify the Item Assignment resource.

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

customer_profile_sidSID<BU>

Not PII

The unique string that we created to identify the CustomerProfile resource.

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

account_sidSID<AC>

Not PII

The SID of the Account that created the Item Assignment resource.

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

channel_endpoint_typestring

Not PII

The type of channel endpoint. eg: phone-number

channel_endpoint_sidSID

Not PII

The SID of an channel endpoint

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

date_createdstring<date-time>

Not PII

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

urlstring<uri>

Not PII

The absolute URL of the Identity resource.

Create a new Assigned Item.

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

Path parameters

Property nameTypeRequiredPIIDescription

CustomerProfileSidSID<BU>required

Not PII

The unique string that we created to identify the CustomerProfile resource.

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

Request body parameters

Property nameTypeRequiredPIIDescription

ChannelEndpointTypestringrequired

Not PII

The type of channel endpoint. eg: phone-number

ChannelEndpointSidSIDrequired

Not PII

The SID of an channel endpoint

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

Create a CustomerProfileChannelEndpointAssignment

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_21// Download the helper library from https://www.twilio.com/docs/node/install
_21const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_21
_21// Find your Account SID and Auth Token at twilio.com/console
_21// and set the environment variables. See http://twil.io/secure
_21const accountSid = process.env.TWILIO_ACCOUNT_SID;
_21const authToken = process.env.TWILIO_AUTH_TOKEN;
_21const client = twilio(accountSid, authToken);
_21
_21async function createCustomerProfileChannelEndpointAssignment() {
_21  const customerProfilesChannelEndpointAssignment = await client.trusthub.v1
_21    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_21    .customerProfilesChannelEndpointAssignment.create({
_21      channelEndpointSid: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_21      channelEndpointType: "ChannelEndpointType",
_21    });
_21
_21  console.log(customerProfilesChannelEndpointAssignment.sid);
_21}
_21
_21createCustomerProfileChannelEndpointAssignment();

Output


_10{
_10  "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "channel_endpoint_sid": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "channel_endpoint_type": "ChannelEndpointType",
_10  "date_created": "2019-07-31T02:34:41Z",
_10  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_10}

Fetch specific Assigned Item Instance.

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

Path parameters

Property nameTypeRequiredPIIDescription

CustomerProfileSidSID<BU>required

Not PII

The unique string that we created to identify the CustomerProfile resource.

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

SidSID<RA>required

Not PII

The unique string that we created to identify the resource.

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

Fetch a CustomerProfileChannelEndpointAssignment

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_21// Download the helper library from https://www.twilio.com/docs/node/install
_21const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_21
_21// Find your Account SID and Auth Token at twilio.com/console
_21// and set the environment variables. See http://twil.io/secure
_21const accountSid = process.env.TWILIO_ACCOUNT_SID;
_21const authToken = process.env.TWILIO_AUTH_TOKEN;
_21const client = twilio(accountSid, authToken);
_21
_21async function fetchCustomerProfileChannelEndpointAssignment() {
_21  const customerProfilesChannelEndpointAssignment = await client.trusthub.v1
_21    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_21    .customerProfilesChannelEndpointAssignment(
_21      "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_21    )
_21    .fetch();
_21
_21  console.log(customerProfilesChannelEndpointAssignment.sid);
_21}
_21
_21fetchCustomerProfileChannelEndpointAssignment();

Output


_10{
_10  "sid": "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "customer_profile_sid": "BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "channel_endpoint_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_10  "channel_endpoint_type": "phone-number",
_10  "date_created": "2019-07-31T02:34:41Z",
_10  "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_10}

Retrieve a list of all Assigned Items for an account.

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

Path parameters

Property nameTypeRequiredPIIDescription

CustomerProfileSidSID<BU>required

Not PII

The unique string that we created to identify the CustomerProfile resource.

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

Query parameters

Property nameTypeRequiredPIIDescription

ChannelEndpointSidSIDOptional

Not PII

The SID of an channel endpoint

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

ChannelEndpointSidsstringOptional

Not PII

comma separated list of channel endpoint sids

PageSizeintegerOptional

Not PII

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

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

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

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

List multiple CustomerProfileChannelEndpointAssignments

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function listCustomerProfileChannelEndpointAssignment() {
_18  const customerProfilesChannelEndpointAssignments = await client.trusthub.v1
_18    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .customerProfilesChannelEndpointAssignment.list({ limit: 20 });
_18
_18  customerProfilesChannelEndpointAssignments.forEach((c) => console.log(c.sid));
_18}
_18
_18listCustomerProfileChannelEndpointAssignment();

Output


_12{
_12  "results": [],
_12  "meta": {
_12    "page": 0,
_12    "page_size": 50,
_12    "first_page_url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0",
_12    "previous_page_url": null,
_12    "url": "https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments?PageSize=50&Page=0",
_12    "next_page_url": null,
_12    "key": "results"
_12  }
_12}

Remove an Assignment Item Instance.

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

Path parameters

Property nameTypeRequiredPIIDescription

CustomerProfileSidSID<BU>required

Not PII

The unique string that we created to identify the CustomerProfile resource.

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

SidSID<RA>required

Not PII

The unique string that we created to identify the resource.

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

Delete a CustomerProfileChannelEndpointAssignment

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19
_19async function deleteCustomerProfileChannelEndpointAssignment() {
_19  await client.trusthub.v1
_19    .customerProfiles("BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19    .customerProfilesChannelEndpointAssignment(
_19      "RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_19    )
_19    .remove();
_19}
_19
_19deleteCustomerProfileChannelEndpointAssignment();