Update an agent
PATCH/agents/:agent_id
Update an agent's profile, role or activation state.
Email and password cannot be changed here — both answer 400 with
code: field_not_editable. They are identity rather than profile: an email
change re-keys the global login index and must be confirmed from the address
itself, and a password can only be set by the person who owns it.
The account's last Owner cannot be moved off Owner or deactivated. That answers
400 with code: last_owner — an account must never be able to lock itself out
of its own product.
Request
Responses
- 200
- 400
- 401
- 403
- 404
The updated agent.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
The request was malformed, or a parameter was rejected.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No token, an expired token, or a credential that has been revoked.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No such resource in this account.
Response Headers
Correlation id for this request. Quote it when reporting a problem.