Skip to contentSkip to navigationSkip to topbar
Page tools
Useful for sharing or LLM
Accelerate development with AI
On this page
Looking for more inspiration?Visit the

EndUser Resource

EndUser Properties

enduser-properties page anchor
Property nameTypeRequiredPIIDescriptionChild properties
sidSID<IT>

Optional

Not PII

The unique string created by Twilio to identify the End User resource.

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

Optional

Not PII

The SID of the Account that created the End User resource.

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

Optional

Not PII

The string that you assigned to describe the resource.

typestring

Optional

Not PII

The type of end user of the Bundle resource - can be individual or business.

attributes

Optional

PII MTL: 30 days

The set of parameters that are the attributes of the End Users resource which are listed in the End User Types.

dateCreatedstring<date-time>

Optional

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.

dateUpdatedstring<date-time>

Optional

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.

urlstring<uri>

Optional

Not PII

The absolute URL of the End User resource.

Create an EndUser resource

create-an-enduser-resource page anchor

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

Request body parameters

request-body-parameters page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
friendlyNamestring
required
Not PII

The string that you assigned to describe the resource.

typestring
required
Not PII

The type of end user of the Bundle resource - can be individual or business.

attributes

Optional

PII MTL: 30 days

The set of parameters that are the attributes of the End User resource which are derived End User Types.

Create a new End UserLink to code sample: Create a new End User
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 at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function createEndUser() {

14
  const endUser = await client.trusthub.v1.endUsers.create({

15
    friendlyName: "FriendlyName",

16
    type: "Type",

17
  });

18


19
  console.log(endUser.sid);

20
}

21


22
createEndUser();

Response

Note about this response
1
{

2
  "date_updated": "2021-02-16T20:40:57Z",

3
  "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "friendly_name": "FriendlyName",

5
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
  "url": "https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

7
  "date_created": "2021-02-16T20:40:57Z",

8
  "attributes": {

9
    "phone_number": "+11234567890",

10
    "job_position": "CEO",

11
    "first_name": "rep1",

12
    "last_name": "test",

13
    "business_title": "ceo",

14
    "email": "foobar@test.com"

15
  },

16
  "type": "Type"

17
}

Fetch an EndUser resource

fetch-an-enduser-resource page anchor

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

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
sidSID<IT>
required
Not PII

The unique string created by Twilio to identify the End User resource.

Pattern: ^IT[0-9a-fA-F]{32}$Min length: 34Max length: 34
Fetch specific End User InstanceLink to code sample: Fetch specific End User Instance
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 at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function fetchEndUser() {

14
  const endUser = await client.trusthub.v1

15
    .endUsers("ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

16
    .fetch();

17


18
  console.log(endUser.sid);

19
}

20


21
fetchEndUser();

Response

Note about this response
1
{

2
  "date_updated": "2021-02-16T20:40:57Z",

3
  "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "friendly_name": "auth_rep_1",

5
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
  "url": "https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

7
  "date_created": "2021-02-16T20:40:57Z",

8
  "attributes": {

9
    "phone_number": "+11234567890",

10
    "job_position": "CEO",

11
    "first_name": "rep1",

12
    "last_name": "test",

13
    "business_title": "ceo",

14
    "email": "foobar@test.com"

15
  },

16
  "type": "authorized_representative_1"

17
}

Read multiple EndUser resources

read-multiple-enduser-resources page anchor

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

Query parameters

query-parameters page anchor
Property nameTypeRequiredPIIDescription
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.

Retrieve a list of all End User for an accountLink to code sample: Retrieve a list of all End User for an account
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 at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function listEndUser() {

14
  const endUsers = await client.trusthub.v1.endUsers.list({ limit: 20 });

15


16
  endUsers.forEach((e) => console.log(e.sid));

17
}

18


19
listEndUser();

Response

Note about this response
1
{

2
  "results": [],

3
  "meta": {

4
    "page": 0,

5
    "page_size": 50,

6
    "first_page_url": "https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0",

7
    "previous_page_url": null,

8
    "url": "https://trusthub.twilio.com/v1/EndUsers?PageSize=50&Page=0",

9
    "next_page_url": null,

10
    "key": "results"

11
  }

12
}

Update an EndUser resource

update-an-enduser-resource page anchor

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

Path parameters

path-parameters-1 page anchor
Property nameTypeRequiredPIIDescription
sidSID<IT>
required
Not PII

The unique string created by Twilio to identify the End User resource.

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

Request body parameters

request-body-parameters-1 page anchor
Encoding type:application/x-www-form-urlencoded
SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
friendlyNamestring

Optional

Not PII

The string that you assigned to describe the resource.

attributes

Optional

PII MTL: 30 days

The set of parameters that are the attributes of the End User resource which are derived End User Types.

Update an existing End UserLink to code sample: Update an existing End User
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 at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function updateEndUser() {

14
  const endUser = await client.trusthub.v1

15
    .endUsers("ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

16
    .update({ friendlyName: "FriendlyName" });

17


18
  console.log(endUser.sid);

19
}

20


21
updateEndUser();

Response

Note about this response
1
{

2
  "date_updated": "2021-02-16T20:40:57Z",

3
  "sid": "ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "friendly_name": "FriendlyName",

5
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

6
  "url": "https://trusthub.twilio.com/v1/EndUsers/ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

7
  "date_created": "2021-02-16T20:40:57Z",

8
  "attributes": {

9
    "phone_number": "+11234567890",

10
    "job_position": "CEO",

11
    "first_name": "rep1",

12
    "last_name": "test",

13
    "business_title": "ceo",

14
    "email": "foobar@test.com"

15
  },

16
  "type": "authorized_representative_1"

17
}

Delete an EndUser resource

delete-an-enduser-resource page anchor

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

Path parameters

path-parameters-2 page anchor
Property nameTypeRequiredPIIDescription
sidSID<IT>
required
Not PII

The unique string created by Twilio to identify the End User resource.

Pattern: ^IT[0-9a-fA-F]{32}$Min length: 34Max length: 34
Delete a specific End UserLink to code sample: Delete a specific End User
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 at twilio.com/console

5
// Provision API Keys at twilio.com/console/runtime/api-keys

6
// and set the environment variables. See http://twil.io/secure

7
// For local testing, you can use your Account SID and Auth token

8
const accountSid = process.env.TWILIO_ACCOUNT_SID;

9
const apiKey = process.env.TWILIO_API_KEY;

10
const apiSecret = process.env.TWILIO_API_SECRET;

11
const client = twilio(apiKey, apiSecret, { accountSid: accountSid });

12


13
async function deleteEndUser() {

14
  await client.trusthub.v1

15
    .endUsers("ITaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

16
    .remove();

17
}

18


19
deleteEndUser();