Skip to main content

Update Support Tenant Settings

PUT 
/api/support/admin/tenants/:tenant/settings

Updates a tenant's support settings. This is a partial update: any field you omit keeps its current value. Send sla_policy_id: null or notes: null to clear those, and default_watcher_user_ids: [] to remove every default watcher. Returns the settings after the write, in the same shape as Get Support Tenant Settings.

Required scope: support:write

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

Request body

  • default_watcher_user_ids (integer[], optional) — user ids to add as watchers on every new ticket from this tenant. At most 20; duplicates are dropped. Every id must be a member of this tenant, otherwise the request fails with a 422.
  • default_watcher_user_ids[] (integer, min 1, distinct) — each entry is a user id.
  • sla_policy_id (integer, optional, nullable) — the SLA policy to apply to this tenant's tickets instead of the default. Must be an existing policy id; null removes the override.
  • notes (string, optional, nullable, max 2000) — free-text notes for agents. Leading/trailing whitespace is trimmed; a blank string is stored as null.

Side effects: default watchers are added by the automation rules when a new ticket is created for this tenant (the add_tenant_default_watchers action); changing the list does not touch existing tickets. The SLA override applies to tickets created after the change.

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.

Request​

Responses​

OK

Response Headers
    Content-Type