Ticket quick replies ticket-quick-replies
Global quick replies for admins.
Pick an endpoint to see its example call on the right.
Authentication
Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.
X-API-Key
Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).
Conventions
Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.
Times are RFC 3339 (UTC); amounts are in cents.
Writes return 200/201/204 on success; duplicates of a unique key return 409.
/api/v2/ticket-quick-repliesList quick replies
Authentication: Admin only
/api/v2/ticket-quick-repliesCreate a quick reply
Authentication: Admin only
Request body application/json
| Field | Type | Description |
|---|---|---|
contentRequired | string | Content, 1 to 1000 characters. |
sort | integer | Sort order; default 100. |
titleRequired | string | Title, 1 to 20 characters. |
/api/v2/ticket-quick-replies/{id}Update a quick reply
Authentication: Admin only
Request body application/json
| Field | Type | Description |
|---|---|---|
contentRequired | string | Content, 1 to 1000 characters. |
sort | integer | Sort order; default 100. |
titleRequired | string | Title, 1 to 20 characters. |
/api/v2/ticket-quick-replies/{id}Delete a quick reply
Authentication: Admin only
Ticket quick replies object
| Field | Type | Description |
|---|---|---|
contentRequired | string | Content, 1 to 1000 characters. |
created_at | string | Created at |
id | integer | Record ID |
items | TicketQuickReply[] | Items on this page |
sort | integer | Sort order; default 100. |
titleRequired | string | Title, 1 to 20 characters. |
updated_at | string | Updated at |
Responses and errors
Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"code": "validation_failed",
"detail": "Invalid request parameters",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name is required"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}