Skip to main content

Update AI Agent Settings

PUT 
/api/support/agent/ai/settings

Pause or resume all AI work across the desk. While paused, the AI agent claims nothing new and starts no runs, but still honours stop requests and keeps reporting in. Resuming clears paused_by, paused_at and reason. No ticket event is recorded; the change is pushed on support.agents as support.ai.changed.

Required scope: support:write

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

Request body

  • paused (boolean, required)
  • reason (string, optional, max 500) — shown to the other agents

The response is the new status (fields as in Get AI Agent Status).

Authentication: Bearer token with the support:write scope, or an authenticated session, from a support admin — agents and viewers get a 403. No tenant context — this endpoint is central.

Request​

Responses​

OK

Response Headers
    Content-Type