Skip to main content

Get AI Suggestion Settings

GET 
/api/support/admin/ai-settings

Returns the desk-wide AI suggestion settings: for each ticket property the model can suggest, what happens with its answer. These settings apply to every tenant — this is how the support desk itself behaves.

Required scope: support:read

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).

Response fields (data)

  • suggestions (object) — the current mode per property; always complete, even for properties never saved
  • properties[] (array of strings) — the properties that can be suggested
  • modes[] (array of strings) — the modes a property can be set to

Authentication: Bearer token with the support:read 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