Mail 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 Mail API exposes the Mail admin screens — mailboxes, ignored subjects, excluded emails and the sent-mail audit. Every endpoint runs as the token’s owner and is gated by the mail ability plus the owner’s admin role.
Note: sending mail is not part of this family — outbound transport stays an internal-only endpoint. Gmail OAuth connection and raw .eml download are browser-only flows and are not exposed.
Abilities and conventions
mail:read— read endpoints.mail:write— create / update / delete endpoints. Write implies read.
All endpoints are POST and JSON. Mailbox reads never include secrets (POP/SMTP passwords, OAuth refresh token) — only a gmail_connected flag.
Endpoints
| Method & path | Ability | Purpose |
|---|---|---|
| POST /api/v1/mail/mailboxes | mail:read | List mailboxes (+ selectable queues) |
| POST /api/v1/mail/mailboxes/create | mail:write | Create a mailbox |
| POST /api/v1/mail/mailboxes/update | mail:write | Update a mailbox by mailbox_id |
| POST /api/v1/mail/mailboxes/set-password | mail:write | Set a POP/SMTP/client secret (field, value) |
| POST /api/v1/mail/mailboxes/delete | mail:write | Delete a mailbox by mailbox_id |
| POST /api/v1/mail/subjects | mail:read | List ignored subjects |
| POST /api/v1/mail/subjects/create | mail:write | Add an ignored subject (subject) |
| POST /api/v1/mail/subjects/delete | mail:write | Delete an ignored subject by id |
| POST /api/v1/mail/excluded-emails | mail:read | List excluded emails |
| POST /api/v1/mail/excluded-emails/create | mail:write | Add an excluded email (email) |
| POST /api/v1/mail/excluded-emails/delete | mail:write | Delete an excluded email by id |
| POST /api/v1/mail/sent-mail | mail:read | Recent sent mail (range_days, 1–30) |
| POST /api/v1/mail/sent-mail/search | mail:read | Search sent mail (q, limit) |
| POST /api/v1/mail/sent-mail/show | mail:read | Fetch one sent message by id |