Zammad API
14 endpoints for Zammad, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.
- Base URL
- https://cotlet.dev/api/v1/zammad
- Connects with
- Your own Zammad agent login on your instance, cloud or self-hosted (the address must open from the internet). What your agent can do follows your role and group permissions. You sign in in your own browser and keep your SSO or 2-step verification.
- Integration page
- Zammad
Read (7)
Return data and change nothing in the account.
| Endpoint | Description |
|---|---|
| GET | Zammad's own ticket search: free text or attributes such as state.name and customer.lastname. |
| GET | The ticket overviews your account sees, such as Unassigned & Open Tickets. |
| GET | Tickets in one overview with state, priority, group, owner and article count. |
| GET | One ticket with its attributes, customer and tags, without the messages. |
| GET | The messages and notes of a ticket, oldest first, with sender, type and visibility. |
| GET | The groups, owners, states and priorities your account can set on a ticket. |
| GET | Macros your account can run on a ticket, such as Close & Tag as Spam. |
Write (7)
Change the account. Calls marked Confirm wait for the user to approve them.
| Endpoint | Description |
|---|---|
| PATCH | Change a ticket's state, priority, group, owner or title. |
| POST | Add a tag to a ticket. |
| DELETE | Remove a tag from a ticket. |
| POST | Write a note on a ticket that the customer cannot see. |
| POST | Send an email reply to the customer on the ticket's thread. |
| POST | Apply a macro to a ticket, as the Update menu does. |
| POST | Merge a duplicate ticket into another ticket. |