Update an existing frontline user

POST /v1/Users/{Sid}

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.

Body

Avatar string

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

The string that you assigned to describe the User.
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.
State string

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

Values are active or deactivated.

Responses

200

OK
Hide response attributes Show response attributes object
- avatar string | null
  
  The avatar URL which will be shown in Frontline application
- friendly_name string | null
  
  The string that you assigned to describe the User
- identity string | null
  
  The string that identifies the resource's User
- is_available boolean | null
  
  Whether the User is available for new conversations
- sid string | null
  
  The unique string that identifies the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^US[0-9a-fA-F]{32}$.
- state string | null
  
  Current state of this user
  
  Values are active or deactivated.
- url string(uri) | null
  
  An absolute URL for this user.

POST /v1/Users/{Sid}

curl \
 -X POST https://frontline-api.twilio.com/v1/Users/{Sid} \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Avatar=string&FriendlyName=string&IsAvailable=true&State=active'

Request example

{
  "Avatar": "string",
  "FriendlyName": "string",
  "IsAvailable": true,
  "State": "active"
}

Request examples

{
  "Avatar": "string",
  "FriendlyName": "string",
  "IsAvailable": true,
  "State": "active"
}

Response examples (200)

{
  "avatar": "string",
  "friendly_name": "string",
  "identity": "string",
  "is_available": true,
  "sid": "string",
  "state": "active",
  "url": "https://example.com"
}

Response examples (200)

{
  "avatar": "string",
  "friendly_name": "string",
  "identity": "string",
  "is_available": true,
  "sid": "string",
  "state": "active",
  "url": "https://example.com"
}