Skip to main content

Update Support Agent

PUT 
/api/support/admin/agents/:agent

Partially updates a support seat: change the role, edit the profile, set the notification flags, or re-activate a revoked seat with is_active: true. Only the fields you send change; sending null for a nullable field clears it.

Required scope: support:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Request body (every field optional)

  • role (string) — one of: admin, agent, viewer.
  • display_name (string, nullable) — max 100. null clears it so the user's name is used.
  • signature (string, nullable) — max 2000. null clears it.
  • notifications (object, nullable) — replaces the stored flags as a whole. Keys: new_ticket, customer_reply, sla, mention (each boolean, optional); keys you omit fall back to their default of true. null resets every flag to true.
  • is_active (boolean) — true re-activates a revoked seat; false revokes it (same effect as Delete Support Agent).

The last effective admin (active, role admin, super admin) can never be demoted or deactivated: such a change is refused with 422 and the error is reported under role.

Response: 200 with the updated seat.

Authentication: Bearer token with the support:write scope, or an authenticated session, from a caller with an active support role who also holds the support admin role. No tenant context — this endpoint is central.

The response reports is_deleted (the seat's user has been removed from sku.io) and is_effective (active AND super admin AND not deleted) — a seat whose user was deleted can still be edited, but it grants nothing until that user is restored.

Request​

Responses​

OK

Response Headers
    Content-Type