Agents
Update Agent in Account
Update an Agent in Account
Authorization
userApiKey api_access_token<token>
This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
In: header
Path Parameters
id*integer
The ID of the agent to be updated.
account_id*integer
The numeric ID of the account
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v1/accounts/0/agents/0" \ -H "Content-Type: application/json" \ -d '{ "role": "agent" }'{
"id": 0,
"account_id": 0,
"availability_status": "available",
"auto_offline": true,
"confirmed": true,
"email": "string",
"available_name": "string",
"name": "string",
"role": "agent",
"thumbnail": "string",
"custom_role_id": 0
}{
"description": "string",
"errors": [
{
"field": "string",
"message": "string",
"code": "string"
}
]
}{
"description": "string",
"errors": [
{
"field": "string",
"message": "string",
"code": "string"
}
]
}