Version 2.4.8 · latest

Ticket settings ticket-settings

Auto-close, reminder, reopen window and rating switch.

Pick an endpoint to see its example call on the right.

TicketsAuthentication: Admin only2 endpoints

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.

PUT/api/v2/ticket-settingsUpdate ticket settings

Authentication: Admin only

Request body application/json

FieldTypeDescription
admin_bot_enabledboolean Send the same events to enabled webhook bots whose events include ticket; omitted = unchanged; default on.
admin_email_enabledboolean Email the platform contact address on new tickets, user replies, reopens and bad ratings; omitted = unchanged; default on.
auto_close_daysRequiredinteger Days until auto-close (from the last staff reply), 1 to 30; default 7.
Default 7
auto_close_enabledRequiredboolean Auto-close when the user does not reply.
bot_summary_enabledboolean Include the first 200 characters of the message in bot posts; off = title, status and link only. Omitted = unchanged; default on.
rating_enabledRequiredboolean Allow ratings.
remind_daysRequiredinteger Days until the reminder, 1 to 29, less than the auto-close days; default 1.
Default 1
remind_enabledRequiredboolean Remind the user before auto-close.
reopen_daysRequiredinteger Days after closing during which reopening is allowed, 1 to 365; default 30.
Default 30
reopen_enabledRequiredboolean Allow the user to reopen after closing.

Ticket settings object

FieldTypeDescription
admin_bot_enabledboolean Send the same events to enabled webhook bots whose events include ticket; omitted = unchanged; default on.
admin_email_enabledboolean Email the platform contact address on new tickets, user replies, reopens and bad ratings; omitted = unchanged; default on.
auto_close_daysinteger Days until auto-close (from the last staff reply), 1 to 30; default 7.
Default 7
auto_close_enabledboolean Auto-close when the user does not reply.
bot_summary_enabledboolean Include the first 200 characters of the message in bot posts; off = title, status and link only. Omitted = unchanged; default on.
rating_enabledboolean Allow ratings.
remind_daysinteger Days until the reminder, 1 to 29, less than the auto-close days; default 1.
Default 1
remind_enabledboolean Remind the user before auto-close.
reopen_daysinteger Days after closing during which reopening is allowed, 1 to 365; default 30.
Default 30
reopen_enabledboolean 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.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "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"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command