Skip to main content

Create Support Group

POST 
/api/support/admin/groups

Creates a support group. The key is the stable identifier tickets carry (group_key) and is what rules, filters and the ticket endpoints use; it cannot be changed later while any ticket references it.

Required scope: support:write

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

Request body

  • key (string, required) — lowercase letters, digits and underscores only (^[a-z0-9_]+$); max 32; must be unique.
  • name (string, required) — max 100.
  • description (string, optional, nullable) — max 1000.
  • position (integer, optional, nullable) — display order, 0–65535. Defaults to one past the highest existing position.
  • is_default (boolean, optional) — make this the default group. Defaults to false, except that the very first group created when no default exists becomes the default automatically. Setting true unsets the previous default.

Response: 201 with the group (tickets_count is 0 for a new group).

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​

Created

Response Headers
    Content-Type