Update an existing frontline user

POST /v1/Users/{Sid}

Account sid auth token

A User resource represents a frontline user.

Path parameters

Sid string Required

The SID of the User resource to update. This value can be either the sid or the identity of the User resource to update.

application/x-www-form-urlencoded

Body

FriendlyName string

The string that you assigned to describe the User.
Avatar string

The avatar URL which will be shown in Frontline application.
State string

Current state of this user. Can be either active or deactivated and defaults to active

Values are active or deactivated.
IsAvailable boolean

Whether the User is available for new conversations. Set to false to prevent User from receiving new inbound conversations if you are using Pool Routing.

Responses

200 application/json

OK
Hide headers attributes Show headers attributes
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- sid string | null
  
  The unique string that we created to identify the User resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^US[0-9a-fA-F]{32}$.
- identity string | null
  
  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 string | null
  
  The string that you assigned to describe the User.
- avatar string | null
  
  The avatar URL which will be shown in Frontline application.
- state string
  
  Current state of this user. Can be either active or deactivated and defaults to active
  
  Values are active or deactivated.
- is_available boolean | null
  
  Whether the User is available for new conversations. Defaults to false for new users.
- url string(uri) | null
  
  An absolute API resource URL for this user.

POST /v1/Users/{Sid}

curl \
 --request POST 'https://frontline-api.twilio.com/v1/Users/{Sid}' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'State=active&Avatar=https%3A%2F%2Fexample.com%2Favatar.png&IsAvailable=true&FriendlyName=Name'

Request example

{"State"=>"active", "Avatar"=>"https://example.com/avatar.png", "IsAvailable"=>true, "FriendlyName"=>"Name"}

Response examples (200)

{
  "sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://frontline-api.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "state": "active",
  "avatar": "https://example.com/profile.png",
  "identity": "john@example.com",
  "is_available": true,
  "friendly_name": "John Doe"
}