Skip to main content

Update AI Suggestion Settings

PUT 
/api/support/admin/ai-settings

Updates the desk-wide AI suggestion settings. Only the properties present in the payload change; anything left out keeps its current mode, so a caller that knows about three properties cannot silently reset a fourth. Unknown property keys and unknown modes are rejected.

Required scope: support:write

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

The three modes

  • show (the default) — the suggestion is offered with its one-line reason and nothing is written until an agent accepts it
  • hide — the property is never suggested: no suggestion, no write
  • auto_apply — the triage writes the property itself and records what it set, and why, on the ticket timeline

The five properties: type, priority, group, assignee, and tenant (only ever suggested for a ticket that arrived without one, e.g. an email from an address that cannot be placed).

Request body

  • suggestions (required, object) — the modes to save, keyed by property
  • suggestions.<property> (optional, string) — one of show, hide, auto_apply, for any of type, priority, group, assignee, tenant

The response is the settings after the write, in the same shape as Get AI Suggestion Settings.

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

Request​

Responses​

OK

Response Headers
    Content-Type