User Resource
API Base URL
All URLs in the reference documentation use the following base URL:
https://frontline-api.twilio.com/v1
User properties
| Resource Properties in REST API format | |
|---|---|
sid
|
The unique string that we created to identify the User resource. |
identity
|
The application-defined string that uniquely identifies the resource's User. This value is often a username or an email address, and is case-sensitive. |
friendly_name
|
The string that you assigned to describe the User. |
avatar
|
The avatar URL which will be shown in Frontline application. |
state
|
Current state of this user. Can be either |
is_available
|
Whether the User is available for new conversations. Defaults to |
url
|
An absolute API resource URL for this user. |
Fetch an User resource
https://frontline-api.twilio.com/v1/Users/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the User resource to fetch. This value can be either the |
Example 1
Update an User resource
https://frontline-api.twilio.com/v1/Users/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the User resource to update. This value can be either the |
friendly_name
Optional
|
The string that you assigned to describe the User. |
avatar
Optional
|
The avatar URL which will be shown in Frontline application. |
state
Optional
|
Current state of this user. Can be either |
is_available
Optional
|
Whether the User is available for new conversations. Set to |
Example 1
Example 2
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.