Update an agent's profile
PATCH/agents/:agent_id/profile
Update display name, timezone, language or contact details.
timezone is an IANA name such as Asia/Jerusalem, and it is validated — a typo
is a 400 rather than a profile that silently renders every timestamp in UTC.
Email, password and role_id are rejected here with code: field_not_editable.
The first two are identity, not profile; roles belong to
PATCH /v1/agents/{agent_id} under the agents_teams scope.
Request
Responses
- 200
- 400
- 401
- 403
- 404
The updated profile.
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.