Settings API
This article and the rest of the API documentation in this section are written for a technical audience — integrators and developers connecting external systems to Tickiti. Familiarity with HTTP, REST, JSON and bearer-token authentication is assumed.
The Settings API exposes the personal/shared Settings screens — perspectives, watchlists, hashtags and stock responses — over the bearer-token API. Every endpoint runs as the token’s owner and is gated by the settings ability plus the owner’s staff role, so a call can do exactly what that user could do in the interface (a non-admin still can’t edit a shared perspective, for example).
Abilities and conventions
settings:read— read endpoints.settings:write— create / update / delete endpoints. Write implies read, so a write token also satisfies the read endpoints.
All endpoints are POST and JSON. Request and response shapes match the corresponding Settings screen; the notes below highlight the key fields. Validation, plan caps and ownership rules are the same as the UI because the API reuses that code.
Endpoints
| Method & path | Ability | Purpose |
|---|---|---|
| POST /api/v1/settings/perspectives | settings:read | List the caller’s perspectives |
| POST /api/v1/settings/perspectives/create | settings:write | Create a perspective (name, shared, conditions, orders) |
| POST /api/v1/settings/perspectives/update | settings:write | Update a perspective by perspective_id |
| POST /api/v1/settings/perspectives/delete | settings:write | Delete a perspective by perspective_id |
| POST /api/v1/settings/watchlists | settings:read | List visible watchlists (+ colour pickers) |
| POST /api/v1/settings/watchlists/create | settings:write | Create a watchlist (name, icon, shared) |
| POST /api/v1/settings/watchlists/update | settings:write | Update a watchlist by watchlist_id |
| POST /api/v1/settings/watchlists/delete | settings:write | Delete a watchlist by watchlist_id |
| POST /api/v1/settings/watchlists/add-tickets | settings:write | Add ticket_ids to a watchlist |
| POST /api/v1/settings/watchlists/remove-tickets | settings:write | Remove ticket_ids from a watchlist |
| POST /api/v1/settings/watchlists/reorder | settings:write | Reorder a watchlist’s tickets |
| POST /api/v1/settings/hashtags | settings:read | List/search hashtags (optional q) |
| POST /api/v1/settings/hashtags/delete | settings:write | Delete a tag everywhere (tag; admin only) |
| POST /api/v1/settings/stock-responses | settings:read | List stock responses |
| POST /api/v1/settings/stock-responses/show | settings:read | Fetch one stock response by template_id |
| POST /api/v1/settings/stock-responses/create | settings:write | Create a stock response |
| POST /api/v1/settings/stock-responses/update | settings:write | Update a stock response |
| POST /api/v1/settings/stock-responses/delete | settings:write | Delete a stock response by template_id |
Notes
- The stock-response endpoints act on stock responses only. Templates and FAQs are managed through the Templates API.
- Hashtag delete requires the owner to be an admin (enforced in-app), even with a
settings:writetoken. - Shared perspectives/watchlists can only be created or edited by an admin owner; everyone else is limited to their own.