Skip to main content

Create Saved View

POST 
/api/support/agent/saved-views

Saves a set of agent-queue filters as a named view owned by the caller. Private by default; a shared view is visible to every agent but can still only be edited by its owner.

Required scope: support:write

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

Request body

  • name (string, required, max 100)
  • filters (object, required) — at least one key; only the keys listed below are accepted
  • is_shared (boolean, optional) — default false
  • position (integer, optional, 0–65535) — ordering hint; defaults to one past the caller's highest position

The filters object — the agent-queue filter keys (see List Agent Queue Tickets); only these keys are accepted, anything else is rejected with 422:

  • queue (string, nullable) — one of: triage, unassigned, mine, open, waiting, awaiting_release, breaching, snoozed, resolved, all
  • tenant_id (string, nullable, max 64)
  • search (string, nullable, max 200)
  • sort (string, nullable) — one of: updated_at, created_at, priority, first_response_due_at, resolution_due_at
  • direction (string, nullable) — asc or desc
  • assignee_user_id (integer, nullable, min 1)
  • group_key (string, nullable, max 32)
  • priority (string, nullable, max 60) — one value or a comma-separated list of: low, medium, high, urgent
  • type (string, nullable, max 80) — one value or a comma-separated list of: bug, question, feature_request, billing
  • status (string, nullable, max 160) — one value or a comma-separated list of: open, in_progress, waiting_on_customer, awaiting_release, resolved, closed
  • environment (string, nullable) — one value or a comma-separated list of: production, beta, demo, dev. Pins the view to the environments a ticket was raised on, the way tenant_id pins it to one account
  • layout (string, nullable) — how the queue is shown when the view is opened: list or table. Saved with the view, so a shared view opens the same way for everyone
  • columns[] (array of strings, nullable, max 40 entries, each max 64 characters of lowercase letters, digits and underscores) — the columns the table layout shows, in order

Keys sent as null, an empty string or an empty array are dropped before saving; string values are trimmed.

Response fields

  • id (integer), user_id (integer) — the owner's user id
  • owner ({id, name}, nullable)
  • name (string), filters (object — the saved queue filters, see below)
  • is_shared (boolean) — visible to every agent
  • is_mine (boolean) — owned by the caller
  • position (integer) — ordering hint among the owner's views
  • created_at, updated_at (ISO-8601)

Authentication: Bearer token with the support:write scope, or an authenticated session, from a caller with an active support role (any role, including viewer). No tenant context — this endpoint is central.

Request​

Responses​

Created

Response Headers
    Content-Type