Skip to main content

Update Support Settings

PUT 
/api/support/settings

Replaces the account's default watchers — the members who are automatically added as watchers (and notified) on every new ticket raised in this account. Send the complete list; an empty array clears it. Returns the same shape as Get Support Settings.

Required scope: support:write

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

Request body

  • default_watcher_user_ids[] (array of integers, required — may be empty, max 20 items) — user ids of account members. Each id must be an integer ≥ 1, the list must not contain duplicates, and every id must belong to a member of this account (a non-member id is rejected with 422)

Response fields (data)

  • tenant_id (string) — the current tenant
  • default_watcher_user_ids[] (array of integers) — user ids automatically added as watchers to every new ticket in this account
  • default_watchers[] (array) — those users expanded: id, name, email
  • members[] (array, sorted by name) — every member of the account (id, name, email), so a client can offer the valid choices
  • can_edit (boolean) — whether the caller holds the settings.update permission needed by Update Support Settings

Permission: requires the settings.update permission on the caller's user account (tenant admins always have it). Without it the request is refused with 403 — this is a role permission on the user, not a token scope, so a token with support:write still fails until the user is granted the permission. can_edit on Get Support Settings tells you in advance.

Authentication: Bearer token with the support:write scope, or an authenticated session. Customer endpoints run in tenant context — send the X-Tenant-Id header or call from a tenant subdomain.

Request​

Responses​

OK

Response Headers
    Content-Type