Ticket settings ticket-settings
Auto-close, reminder, reopen window and rating switch.
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-settingsGet ticket settings
Authentication: Admin only
/api/v2/ticket-settingsUpdate ticket settings
Authentication: Admin only
Request body application/json
| Field | Type | Description |
|---|---|---|
admin_bot_enabled | boolean | Send the same events to enabled webhook bots whose events include ticket; omitted = unchanged; default on. |
admin_email_enabled | boolean | Email the platform contact address on new tickets, user replies, reopens and bad ratings; omitted = unchanged; default on. |
auto_close_daysRequired | integer | Days until auto-close (from the last staff reply), 1 to 30; default 7. |
auto_close_enabledRequired | boolean | Auto-close when the user does not reply. |
bot_summary_enabled | boolean | Include the first 200 characters of the message in bot posts; off = title, status and link only. Omitted = unchanged; default on. |
rating_enabledRequired | boolean | Allow ratings. |
remind_daysRequired | integer | Days until the reminder, 1 to 29, less than the auto-close days; default 1. |
remind_enabledRequired | boolean | Remind the user before auto-close. |
reopen_daysRequired | integer | Days after closing during which reopening is allowed, 1 to 365; default 30. |
reopen_enabledRequired | boolean | Allow the user to reopen after closing. |
Ticket settings object
| Field | Type | Description |
|---|---|---|
admin_bot_enabled | boolean | Send the same events to enabled webhook bots whose events include ticket; omitted = unchanged; default on. |
admin_email_enabled | boolean | Email the platform contact address on new tickets, user replies, reopens and bad ratings; omitted = unchanged; default on. |
auto_close_days | integer | Days until auto-close (from the last staff reply), 1 to 30; default 7. |
auto_close_enabled | boolean | Auto-close when the user does not reply. |
bot_summary_enabled | boolean | Include the first 200 characters of the message in bot posts; off = title, status and link only. Omitted = unchanged; default on. |
rating_enabled | boolean | Allow ratings. |
remind_days | integer | Days until the reminder, 1 to 29, less than the auto-close days; default 1. |
remind_enabled | boolean | Remind the user before auto-close. |
reopen_days | integer | Days after closing during which reopening is allowed, 1 to 365; default 30. |
reopen_enabled | boolean | Allow the user to reopen after closing. |
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"
}