Skip to main content
POST
Update agent
Required scopes: agents--my:rw,

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
id
string
required

The agent ID.

role
enum<string>

The agent role.

Available options:
viceowner,
administrator,
normal
login_status
enum<string>
default:not accepting chats

The agent's default status right after login.

Available options:
accepting chats,
not accepting chats
job_title
string

The agent's job title.

mobile
string

The agent's mobile number.

max_chats_count
integer

The agent's maximum number of concurrent chats.

Required range: x <= 20
groups
object[]

Groups the agent belongs to.

notifications
enum<string>[]

Agent notifications that are enabled.

Available options:
new_visitor,
incoming_chat,
returning_visitor,
queued_visitor,
visitor_is_typing,
new_goal,
unassigned_chats,
unassigned_chat_messages,
ticket,
inactive_notifications,
mute_all_sounds,
repeat_sound_notifications,
ticket_notifications,
incoming_message_for_focused_chat
email_subscriptions
enum<string>[]

Subscriptions that will be sent to the agent via email.

Available options:
daily_summary,
weekly_summary
work_scheduler
object

The work scheduler options to set for the agent.

Response

200

Agent updated successfully.