Update an agent
Administrator only. Change one or more writable fields; what is not sent stays untouched. At least one writable field must be present — an empty payload is a 400, not a no-op. Refused with 403 on the platform-managed AI agent. name is the user’s global display name, so changing it here changes it on every account the user belongs to.
Authorizations
The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.
Headers
Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.
1
Path Parameters
Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.
1
The agent's user id, as returned when the agent was listed. A hidden admin's id answers 404 here, the same as an id that does not exist.
7
Body
The changes go under an agent wrapper. Administrator only, and refused with 403 on the platform-managed AI agent. At least one writable field must be present — an empty payload is a 400, not a no-op.
Response
The agent after the update. updated_at reflects the underlying user record and may not change when only account-level fields were updated.
A human or AI agent of the account. A hidden admin — the platform's own support user — never appears here, on the list or by id.
7
"Jane Doe"
"jane@acme.com"
agent, administrator, supervisor, assistant, cx_engineer "agent"
online, offline, busy "online"
Whether the agent is moved to offline automatically after a period of inactivity.
true
Per-agent override of the account's default conversation assignment limit. null when the agent uses the account default.
null
false
Teams the agent belongs to, scoped to this account.
Inboxes the agent is a member of, scoped to this account.
"2026-05-02T11:04:17.000Z"
"2026-08-10T14:32:05.123Z"
The name that belongs to this account only, when there is one. It is what name shows; null means name comes from the user's global record.