Support API
The Support module runs the ticket system and everything around it: help desks, canned responses, the knowledge base, the Network Status page, escalation rules, ticket feedback, ticket secrets and email-to-ticket. See Tickets for how it works in the admin area.
Admin calls need Module access on the Support card of the staff group’s Permissions tab, plus each call’s own permission below (Super Administrators have all). See Authentication.
Admin calls
Section titled “Admin calls”ticket_get_list
Section titled “ticket_get_list”POST /api/admin/support/ticket_get_list
Lists tickets for staff: pinned tickets first, then newest first.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
status |
string | open, on_hold or closed. |
priority |
string | low, medium or high (or a stored number). |
assigned |
string | me, none, any or a staff id. |
search |
string | A number finds the ticket by id; text matches the subject, the messages, the guest’s name or email, or the client’s name or email. |
id |
integer | One ticket by id. |
client_id |
integer | Tickets of one client. |
support_helpdesk_id |
integer | Tickets of one help desk (also read as helpdesk_id). |
auth |
string | guest for guest tickets only, client for client tickets only. |
name |
string | Part of a guest ticket’s author name. |
email |
string | Part of a guest ticket’s author email. |
subject |
string | Part of the subject. |
content |
string | Text in any message. |
order_id |
integer | Tickets about this order. |
task |
string | Tickets with a pending task: cancel, upgrade or domain. |
date_from |
string | Created from this day, YYYY-MM-DD. |
date_to |
string | Created up to this day, YYYY-MM-DD. |
page |
integer | Page number, from 1. Default 1. |
per_page |
integer | Rows per page, 1 to 500. Default 100. |
Returns: A paged list of tickets, each as ticket_get returns it without messages, ratings, merged tickets and feedback.
Example
Request parameters:
{ "status": "open", "per_page": 1}result:
{ "pages": 3, "page": 1, "per_page": 1, "total": 3, "list": [ { "id": 21, "support_helpdesk_id": 1, "client_id": 42, "subject": "Cannot reach my site", "status": "open", "priority": 100, "priority_level": "medium", "replies": 1, "assigned_to": null, "created_at": "2026-11-17 08:15:00", "updated_at": "2026-11-17 08:15:00", "helpdesk": { "id": 1, "name": "Technical support" }, "author": { "id": 42, "name": "Jane Doe", "email": "jane@example.com", "role": "client" }, "notes": [] } ]}ticket_get
Section titled “ticket_get”POST /api/admin/support/ticket_get
Returns one ticket with all its messages, notes and staff details.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The ticket id. |
Returns: id, support_helpdesk_id, client_id, access_hash and hash (guest tickets), author_name, author_email, priority (50 low, 100 medium, 150 high), priority_level (low, medium, high), subject, status (open, on_hold, closed), rel_type, rel_id, rel_task, rel_new_value, rel_status, created_at, updated_at; replies; first (the first message); helpdesk (id, name, email, can_reopen, close_after, signature, greeting, dates); author; client (the client’s profile, or empty for a guest); messages (each id, support_ticket_id, client_id, admin_id, content, attachment, ip, dates, author {name, role, email} (the name of an authorized user who wrote it, marked (authorized user)) and ticket_files ({id, name, size_label, image, removed, removed_reason})); ratings_on; message_ratings (message id => stars); unverified_messages (message id => {sender, reason} for emailed messages whose sender could not be verified); rel (the task, with order when it is about an order); assigned_to ({id, name} or null); notes (id, support_ticket_id, admin_id, note, dates, author {name, email}); merged_tickets ({id, subject, merged_at}); feedback ({created_at, staff, comments} or null).
Errors:
- Ticket not found
See Tickets.
ticket_update
Section titled “ticket_update”POST /api/admin/support/ticket_update
Changes a ticket’s help desk, status, subject, priority or assigned staff member.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The ticket id. |
support_helpdesk_id |
integer | Move to this help desk. |
status |
string | open, on_hold or closed. |
subject |
string | The new subject (HTML tags are removed). |
priority |
string | low, medium or high (or 50, 100, 150). |
assigned_to |
integer | Assign to this active staff member, 0 for nobody. The new assignee gets an email unless they assigned it to themselves. |
Returns: true.
Errors:
- Ticket not found
- Helpdesk invalid
- Unknown ticket status
- Choose a priority: Low, Medium or High.
- Choose an active staff member.
Setting status to closed removes the ticket’s secrets and sends the client the feedback request, as closing does.
ticket_assignable_staff
Section titled “ticket_assignable_staff”POST /api/admin/support/ticket_assignable_staff
Lists the staff members a ticket can be assigned to: active staff, by name.
Permission: View support tickets (support.view)
No parameters.
Returns: An object of staff id => name.
ticket_feedback_report
Section titled “ticket_feedback_report”POST /api/admin/support/ticket_feedback_report
Returns the Ratings & Feedback report: reply stars and feedback scores by staff member, and the latest comments.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
period |
string | 30, 90 (default), 365 or all (days back). |
Returns: period; ratings (per staff member: admin_id, name, total, average, stars (1 to 5 => count)); feedback (per staff member: admin_id, name, total, average of the 1 to 10 scores); comments (ticket_id, subject, name, rating, comments, created_at).
See Feedback.
network_issue_get_list
Section titled “network_issue_get_list”POST /api/admin/support/network_issue_get_list
Lists network issues (outages and planned work) of one tab, with the number in each tab.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
group |
string | open, scheduled or resolved; empty for all. |
page |
integer | Page number. Default 1. |
per_page |
integer | 1 to 100. Default 25. |
Returns: {list, total, page, per_page, pages, counts}. counts is {open, scheduled, resolved}. Each issue as network_issue_get returns it. Scheduled work is listed soonest first, the rest newest first.
See Network status.
network_issue_get
Section titled “network_issue_get”POST /api/admin/support/network_issue_get
Returns one network issue.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
id |
integer | The issue id. |
Returns: id, title, description, type (server, system, other), type_title, affecting, server_id, server_name, about (what it is about, as the pages show it), priority (critical, high, medium, low), priority_title, status (reported, investigating, in_progress, outage, scheduled, resolved), status_title, open, start_at, end_at, emailed_at, emailed_count, created_by, created_at, updated_at.
Errors:
- Network issue not found (code 404)
network_issue_save
Section titled “network_issue_save”POST /api/admin/support/network_issue_save
Creates a network issue, or updates one when id is given, and can email the affected clients.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
id |
integer | The issue to update; left out, a new issue. |
title |
string, required | Up to 255 characters. |
type |
string, required | server (needs server_id), system (every client with a service) or other (needs affecting). |
server_id |
integer | A hosting server, for server. |
affecting |
string | What it affects, up to 100 characters, for other. |
priority |
string, required | critical, high, medium or low. |
status |
string, required | reported, investigating, in_progress, outage, scheduled or resolved. |
start_at |
string, required | YYYY-MM-DD HH:MM[:SS] (or YYYY-MM-DDTHH:MM). |
end_at |
string | After start_at; empty for none. |
timezone |
string | The time zone of the two times (IANA name). Default the server’s. |
description |
string | Up to 20,000 characters. |
email |
boolean | Email the affected clients after saving. Default false. |
Returns: {id, emailed}: the issue id and how many clients were emailed.
Errors:
- Network issue not found (code 404)
- Enter a title of at most 255 characters.
- Choose what the issue is about: a server, the system or something else.
- Choose the server.
- Enter what the issue affects, in at most 100 characters.
- Choose the priority.
- Choose the status.
- Enter when the issue starts.
- The end must be a date and time after the start.
A server issue affects clients with an active or suspended hosting service on that server; any other issue affects every client with an active or suspended service. While the Network Status page is on, an issue that is not resolved also puts a notice in the affected clients’ notification bell.
network_issue_delete
Section titled “network_issue_delete”POST /api/admin/support/network_issue_delete
Deletes a network issue.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
id |
integer | The issue id. |
Returns: true.
Errors:
- Network issue not found (code 404)
network_issue_options
Section titled “network_issue_options”POST /api/admin/support/network_issue_options
Returns the choices of the network issue form.
Permission: View support tickets (support.view)
No parameters.
Returns: types, priorities and statuses (key => translated name) and servers (hosting server id => name).
network_status_update
Section titled “network_status_update”POST /api/admin/support/network_status_update
Switches the client area’s Network Status page on or off, and whether visitors who are not signed in may read it.
Permission: Manage settings (support.manage_settings)
| Parameter | Type | Description |
|---|---|---|
network_status |
boolean | The feature on. Default off. |
network_status_public |
boolean | Open the page without signing in. Default off. |
Returns: true.
escalation_rule_get_list
Section titled “escalation_rule_get_list”POST /api/admin/support/escalation_rule_get_list
Lists the ticket escalation rules, by name.
Permission: View support tickets (support.view)
No parameters.
Returns: A list of rules, each as escalation_rule_get returns it.
See Escalation rules.
escalation_rule_get
Section titled “escalation_rule_get”POST /api/admin/support/escalation_rule_get
Returns one escalation rule.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
id |
integer | The rule id. |
Returns: id, name, active, helpdesks, statuses, priorities (what it matches; empty lists match any), minutes (time without a reply), new_helpdesk_id, new_status, new_priority, assign_to, notify (staff ids to email), reply, created_at, updated_at.
Errors:
- Escalation rule not found
escalation_rule_save
Section titled “escalation_rule_save”POST /api/admin/support/escalation_rule_save
Creates an escalation rule, or updates one when id is given. Cron applies active rules to tickets with no reply for the set time.
Permission: Manage settings (support.manage_settings)
| Parameter | Type | Description |
|---|---|---|
id |
integer | The rule to update; left out, a new rule. |
name |
string, required | Up to 100 characters. |
minutes |
integer, required | Minutes without a reply, 1 to 525,600. |
active |
boolean | Default true. |
helpdesks |
array | Help desk ids it matches; empty for any. |
statuses |
array | open, on_hold, closed; empty for any. |
priorities |
array | low, medium, high; empty for any. |
reply |
string | A reply to post, up to 10,000 characters; [NAME], [FIRSTNAME] and [EMAIL] are filled in. |
new_helpdesk_id |
integer | Move the ticket to this help desk. |
new_status |
string | Set this status. |
new_priority |
string | Set this priority. |
assign_to |
integer | Assign to this active staff member. |
notify |
array | Active staff ids to email. |
Returns: The rule’s id.
Errors:
- Name the rule (up to 100 characters).
- Set the time without a reply, in minutes (1 to 525600).
- Choose existing help desks.
- Choose ticket statuses.
- Choose priorities.
- Choose an existing help desk.
- Choose a ticket status.
- Choose a priority: Low, Medium or High.
- Choose an active staff member.
- Choose active staff members to email.
- The reply can be at most 10000 characters.
- Choose at least one action.
- Escalation rule not found
A rule needs at least one action. It acts once per ticket for each last reply, and only on tickets whose time ran out after the rule was made.
escalation_rule_delete
Section titled “escalation_rule_delete”POST /api/admin/support/escalation_rule_delete
Deletes an escalation rule.
Permission: Manage settings (support.manage_settings)
| Parameter | Type | Description |
|---|---|---|
id |
integer | The rule id. |
Returns: true.
Errors:
- Escalation rule not found
ticket_message_update
Section titled “ticket_message_update”POST /api/admin/support/ticket_message_update
Edits a staff reply. The earlier text is kept in the message’s edit history.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The message id. |
content |
string, required | The new text (Markdown). |
Returns: true.
Errors:
- Ticket message not found
- Only admin replies can be edited
ticket_message_history_get_list
Section titled “ticket_message_history_get_list”POST /api/admin/support/ticket_message_history_get_list
Returns the edit history of a ticket message, latest edit first.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The message id. |
Returns: A list of earlier versions: id, support_ticket_message_id, admin_id (who edited), content, created_at and content_html (the text rendered).
Errors:
- Ticket message not found
ticket_delete
Section titled “ticket_delete”POST /api/admin/support/ticket_delete
Deletes a ticket with its messages, notes, edit history and secrets.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The ticket id. |
Returns: true.
Errors:
- Ticket not found
This cannot be undone.
ticket_reply
Section titled “ticket_reply”POST /api/admin/support/ticket_reply
Posts a staff reply. The ticket goes to on_hold (waiting for the client) and the client gets an email.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The ticket id. |
content |
string, required | The reply (Markdown), up to 100,000 characters. |
ticket_files |
array | Ids of files uploaded with ticket_file_upload in this session. |
Returns: The new message’s id.
Errors:
- Ticket not found
- The message is too long: it can have at most 100,000 characters.
Fires onAfterAdminReplyTicket.
Example
Request parameters:
{ "id": 21, "content": "Hello Jane,\n\nThe site is back online. Please check again."}result:
58ticket_close
Section titled “ticket_close”POST /api/admin/support/ticket_close
Closes a ticket. The client gets an email and, if the help desk asks for it, a feedback request.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The ticket id. |
Returns: true (also when it was already closed).
Errors:
- Ticket not found
The ticket’s secrets are removed. Fires onAfterAdminCloseTicket.
ticket_create
Section titled “ticket_create”POST /api/admin/support/ticket_create
Opens a ticket for a client, with a first message from the staff member. The client gets an email.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
client_id |
integer, required | The client id. |
support_helpdesk_id |
integer, required | The help desk. |
subject |
string, required | The subject. |
content |
string, required | The first message (Markdown), up to 100,000 characters. |
status |
string | on_hold (default), open or closed. |
ticket_files |
array | Ids of files uploaded with ticket_file_upload in this session. |
Returns: The new ticket’s id.
Errors:
- Helpdesk invalid
- Client not found.
- Unknown ticket status
- The message is too long: it can have at most 100,000 characters.
Fires onBeforeAdminOpenTicket and onAfterAdminOpenTicket.
Example
Request parameters:
{ "client_id": 42, "support_helpdesk_id": 1, "subject": "Planned server move", "content": "Hello Jane,\n\nWe will move your site on Monday."}result:
22batch_ticket_auto_close
Section titled “batch_ticket_auto_close”POST /api/admin/support/batch_ticket_auto_close
Closes every on_hold ticket that got no reply within its help desk’s close after hours. Cron runs this on its own.
Permission: Manage tickets (support.manage_tickets)
No parameters.
Returns: true.
Each closed ticket loses its secrets and its client gets the feedback request when the help desk asks for one.
ticket_get_statuses
Section titled “ticket_get_statuses”POST /api/admin/support/ticket_get_statuses
Counts tickets by status, or returns the status names.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
titles |
mixed | Any value: return the status names instead of the counts. |
Returns: {total, open, closed, on_hold}; with titles, {open: "Open", on_hold: "On Hold", closed: "Closed"}.
helpdesk_get_list
Section titled “helpdesk_get_list”POST /api/admin/support/helpdesk_get_list
Lists the help desks, newest first.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
search |
string | Part of the name, email or signature. |
page |
integer | Page number, from 1. Default 1. |
per_page |
integer | Rows per page, 1 to 500. Default 100. |
Returns: A paged list. Each row has id, name, email, can_reopen, close_after (hours), signature, created_at, updated_at and hidden (hidden from clients).
See Help desks.
helpdesk_get_pairs
Section titled “helpdesk_get_pairs”POST /api/admin/support/helpdesk_get_pairs
Returns every help desk as id and name pairs.
Permission: View support tickets (support.view)
No parameters.
Returns: An object of help desk id => name.
Example
Request parameters:
{}result:
{ "1": "Technical support", "2": "Billing"}helpdesk_get
Section titled “helpdesk_get”POST /api/admin/support/helpdesk_get
Returns one help desk.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The help desk id. |
Returns: id, name, email, can_reopen, close_after (hours), signature, created_at, updated_at, feedback_request (clients get a feedback request when a ticket closes), hidden (hidden from clients) and greeting (how the staff reply box starts).
Errors:
- Help desk not found
helpdesk_update
Section titled “helpdesk_update”POST /api/admin/support/helpdesk_update
Changes a help desk. Only the fields you send change.
Permission: Manage helpdesks (support.manage_helpdesk)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The help desk id. |
name |
string | The name. |
email |
string | The help desk’s email. |
can_reopen |
boolean | Clients may reopen closed tickets by replying. |
close_after |
integer | Hours a ticket waiting for the client stays open before it closes on its own. |
signature |
string | Signature of staff replies. |
greeting |
string | How the staff reply box starts, up to 500 characters; {name} is the client’s first name; empty for none. |
feedback_request |
boolean | Ask for feedback when a ticket closes. |
hidden |
boolean | Hide the help desk from clients and guests. |
translations |
object | The name in other languages: language code => name. |
Returns: true.
Errors:
- Help desk not found
- The greeting must be text.
- The greeting can be at most 500 characters.
helpdesk_create
Section titled “helpdesk_create”POST /api/admin/support/helpdesk_create
Creates a help desk.
Permission: Manage helpdesks (support.manage_helpdesk)
| Parameter | Type | Description |
|---|---|---|
name |
string, required | The name. |
email |
string | The help desk’s email. |
can_reopen |
boolean | Clients may reopen closed tickets. |
close_after |
integer | Hours before a ticket waiting for the client closes on its own. |
signature |
string | Signature of staff replies. |
Returns: The new help desk’s id.
helpdesk_delete
Section titled “helpdesk_delete”POST /api/admin/support/helpdesk_delete
Deletes a help desk that has no tickets, with its greeting, mailbox and settings.
Permission: Manage helpdesks (support.manage_helpdesk)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The help desk id. |
Returns: true.
Errors:
- Help desk not found
- Cannot remove helpdesk which has tickets
canned_get_list
Section titled “canned_get_list”POST /api/admin/support/canned_get_list
Lists canned responses (saved replies), by category.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
search |
string | Part of the title, the text or the category title. |
category_id |
integer | Responses of one category. |
id |
integer | One response by id. |
page |
integer | Page number, from 1. Default 1. |
per_page |
integer | Rows per page, 1 to 500. Default 100. |
Returns: A paged list. Each row has id, support_pr_category_id, title, content, created_at, updated_at and category ({id, title}).
See Canned responses.
canned_pairs
Section titled “canned_pairs”POST /api/admin/support/canned_pairs
Returns the canned responses grouped by category, for a picker.
Permission: View support tickets (support.view)
No parameters.
Returns: An object of category title => (response id => title).
Example
Request parameters:
{}result:
{ "General": { "1": "Welcome", "3": "Thanks for waiting" }}canned_get
Section titled “canned_get”POST /api/admin/support/canned_get
Returns one canned response.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The response id. |
Returns: id, support_pr_category_id, title, content, created_at, updated_at, category ({id, title}).
Errors:
- Canned reply not found
canned_delete
Section titled “canned_delete”POST /api/admin/support/canned_delete
Deletes a canned response.
Permission: Manage canned responses (support.manage_canned)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The response id. |
Returns: true.
Errors:
- Canned reply not found
canned_create
Section titled “canned_create”POST /api/admin/support/canned_create
Creates a canned response.
Permission: Manage canned responses (support.manage_canned)
| Parameter | Type | Description |
|---|---|---|
title |
string, required | The title. |
category_id |
integer, required | The category id. |
content |
string | The reply text (Markdown). |
Returns: The new response’s id.
Errors:
- Canned category not found
canned_update
Section titled “canned_update”POST /api/admin/support/canned_update
Changes a canned response.
Permission: Manage canned responses (support.manage_canned)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The response id. |
title |
string | The title. |
category_id |
integer | The category id. |
content |
string | The reply text. |
Returns: true.
Errors:
- Canned reply not found
- Canned category not found
canned_category_pairs
Section titled “canned_category_pairs”POST /api/admin/support/canned_category_pairs
Returns the canned response categories as id and title pairs.
Permission: View support tickets (support.view)
No parameters.
Returns: An object of category id => title.
canned_category_get
Section titled “canned_category_get”POST /api/admin/support/canned_category_get
Returns one canned response category with its responses.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The category id. |
Returns: id, title, created_at, updated_at, responses (each as canned_get returns it).
Errors:
- Canned category not found
canned_category_update
Section titled “canned_category_update”POST /api/admin/support/canned_category_update
Renames a canned response category.
Permission: Manage canned responses (support.manage_canned)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The category id. |
title |
string | The new title; left out, it stays. |
Returns: true.
Errors:
- Canned category not found
canned_category_delete
Section titled “canned_category_delete”POST /api/admin/support/canned_category_delete
Deletes a canned response category that has no responses.
Permission: Manage canned responses (support.manage_canned)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The category id. |
Returns: true.
Errors:
- Canned category not found
- Cannot remove category which has canned responses
canned_category_create
Section titled “canned_category_create”POST /api/admin/support/canned_category_create
Creates a canned response category.
Permission: Manage canned responses (support.manage_canned)
| Parameter | Type | Description |
|---|---|---|
title |
string, required | The title. |
Returns: The new category’s id.
note_create
Section titled “note_create”POST /api/admin/support/note_create
Adds a staff note to a ticket. Clients never see notes.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
ticket_id |
integer, required | The ticket id. |
note |
string, required | The note text. |
Returns: The new note’s id.
Errors:
- Ticket not found
note_delete
Section titled “note_delete”POST /api/admin/support/note_delete
Deletes a ticket note.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The note id. |
Returns: true.
Errors:
- Note not found
task_complete
Section titled “task_complete”POST /api/admin/support/task_complete
Marks the ticket’s task (a cancellation or upgrade request) as done. For a domain request it also saves the domain’s values and replies to the client.
Permission: Manage tickets (support.manage_tickets); a domain request also needs Manage domains (servicedomain.manage_domains)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The ticket id. |
Returns: true.
Errors:
- Ticket not found
Marking the task done does not itself cancel or upgrade the order.
batch_delete
Section titled “batch_delete”POST /api/admin/support/batch_delete
Deletes several tickets, as ticket_delete does for each.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
ids |
array, required | The ticket ids. |
Returns: true.
Errors:
- Ticket not found (stops at that id: the tickets before it are already deleted)
This cannot be undone.
kb_article_get_list
Section titled “kb_article_get_list”POST /api/admin/support/kb_article_get_list
Lists knowledge base articles of every status.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
status |
string | active or draft. |
search |
string | Words to find in the title, text or category. |
kb_article_category_id |
integer | Articles of one category (also read as cat). |
page |
integer | Page number, from 1. Default 1. |
per_page |
integer | Rows per page, 1 to 500. Default 100. |
Returns: A paged list. Each row has id, slug, title, views, status, created_at, updated_at, category ({id, slug, title}) and kb_article_category_id.
See Knowledge base.
kb_article_get
Section titled “kb_article_get”POST /api/admin/support/kb_article_get
Returns one knowledge base article with its text.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The article id. |
Returns: The fields of a kb_article_get_list row and content (Markdown).
Errors:
- Article not found
kb_article_create
Section titled “kb_article_create”POST /api/admin/support/kb_article_create
Creates a knowledge base article. Its slug is made from the title.
Permission: Manage knowledge base (support.manage_kb)
| Parameter | Type | Description |
|---|---|---|
kb_article_category_id |
integer, required | The category id. |
title |
string, required | The title. |
status |
string | draft (default) or active (published). |
content |
string | The text (Markdown). |
Returns: The new article’s id.
Errors:
- Knowledge Base category not found
- Invalid knowledge base article status: x
kb_article_update
Section titled “kb_article_update”POST /api/admin/support/kb_article_update
Changes a knowledge base article. Only the fields you send change.
Permission: Manage knowledge base (support.manage_kb)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The article id. |
title |
string | The title. |
kb_article_category_id |
integer | Move to this category. |
slug |
string | The address part of the article page. |
status |
string | active or draft. |
content |
string | The text (Markdown). |
views |
integer | Set the view counter. |
Returns: true.
Errors:
- Article not found
- Knowledge Base category not found
- Invalid knowledge base article status: x
kb_article_delete
Section titled “kb_article_delete”POST /api/admin/support/kb_article_delete
Deletes a knowledge base article.
Permission: Manage knowledge base (support.manage_kb)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The article id. |
Returns: true.
Errors:
- Article not found
kb_category_get_list
Section titled “kb_category_get_list”POST /api/admin/support/kb_category_get_list
Lists knowledge base categories by title, each with its articles.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
q |
string | Words to find in category or article titles and texts; the categories show only matching articles. |
article_status |
string | Only categories with articles of this status (active or draft). |
page |
integer | Page number, from 1. Default 1. |
per_page |
integer | Rows per page, 1 to 500. Default 100. |
Returns: A paged list. Each row has id, title, description, slug, created_at, updated_at, articles (as in kb_article_get_list, without text) and hidden (hidden from clients).
kb_category_get
Section titled “kb_category_get”POST /api/admin/support/kb_category_get
Returns one knowledge base category with its articles.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The category id. |
Returns: id, title, description, slug, created_at, updated_at, articles and hidden.
Errors:
- Article Category not found
kb_category_create
Section titled “kb_category_create”POST /api/admin/support/kb_category_create
Creates a knowledge base category. Its slug is made from the title.
Permission: Manage knowledge base (support.manage_kb)
| Parameter | Type | Description |
|---|---|---|
title |
string, required | The title. |
description |
string | The description. |
Returns: The new category’s id.
kb_category_update
Section titled “kb_category_update”POST /api/admin/support/kb_category_update
Changes a knowledge base category. Only the fields you send change.
Permission: Manage knowledge base (support.manage_kb)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The category id. |
title |
string | The title. |
slug |
string | The address part of the category page. |
description |
string | The description. |
hidden |
boolean | Hide the category and its articles from clients and visitors. |
Returns: true.
Errors:
- Article Category not found
kb_category_delete
Section titled “kb_category_delete”POST /api/admin/support/kb_category_delete
Deletes a knowledge base category that has no articles.
Permission: Manage knowledge base (support.manage_kb)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The category id. |
Returns: true.
Errors:
- Category not found
- Cannot remove category which has articles
kb_category_get_pairs
Section titled “kb_category_get_pairs”POST /api/admin/support/kb_category_get_pairs
Returns the knowledge base categories as id and title pairs.
Permission: View support tickets (support.view)
No parameters.
Returns: An object of category id => title.
ticket_file_upload
Section titled “ticket_file_upload”POST /api/admin/support/ticket_file_upload
Uploads a file for a staff reply, as a multipart form upload in the field file. Send the returned id in the reply’s ticket_files.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
ticket_id |
integer | The client ticket the reply is for (guest tickets take no files). |
file |
mixed, required | The file (multipart form field): smaller than 10 MB, of an allowed type (guest/ticket_file_rules). |
Returns: {id, name, size, size_label}. The id is a 32-character string.
Errors:
- Ticket not found
- Choose a file to attach.
- You attached many files in the last hour. Please try again later. (120 an hour)
- Send your message first: at most 10 files can wait to be sent.
- Each file must be smaller than 10 MB.
- This type of file cannot be attached. Allowed: …
A file that is never sent is removed after a day.
ticket_file_discard
Section titled “ticket_file_discard”POST /api/admin/support/ticket_file_discard
Throws away a file uploaded in this session that was not sent yet.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
id |
string | The upload id. |
Returns: true.
Errors:
- File not found
ticket_file_remove
Section titled “ticket_file_remove”POST /api/admin/support/ticket_file_remove
Removes a sent ticket file, for example one where a client posted a password. The file is deleted and the message shows it was removed.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
id |
string | The file id. |
Returns: true.
Errors:
- File not found
Written to the client’s activity log.
ticket_secret_list
Section titled “ticket_secret_list”POST /api/admin/support/ticket_secret_list
Lists the encrypted secrets clients added to a ticket (labels only) and who opened or deleted them.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
ticket_id |
integer, required | The ticket id. |
Returns: secrets ({id, kind, label, created_at}), events ({action, label, staff_name, created_at}; action opened, deleted or expired), can_open and can_delete (the caller’s permissions).
Errors:
- Ticket not found
See Ticket secrets.
ticket_secret_open
Section titled “ticket_secret_open”POST /api/admin/support/ticket_secret_open
Decrypts and returns one ticket secret. Each opening is recorded under the ticket.
Permission: Open ticket secrets (support.open_secrets)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The secret id. |
Returns: For a server secret: host, type (ssh, panel, other), username, password, ssh_key, note, port. For another secret: label and value.
Errors:
- Ticket not found (the secret does not exist)
ticket_secret_delete
Section titled “ticket_secret_delete”POST /api/admin/support/ticket_secret_delete
Deletes a ticket secret. The deletion is recorded under the ticket.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The secret id. |
Returns: true.
Errors:
- Ticket not found (the secret does not exist)
ticket_files_update
Section titled “ticket_files_update”POST /api/admin/support/ticket_files_update
Saves how many days sent ticket files are kept.
Permission: Manage settings (support.manage_settings)
| Parameter | Type | Description |
|---|---|---|
ticket_files_days |
integer | 0 to 3650; 0 keeps files for good. Default 180 until saved. |
Returns: true.
Errors:
- Keep ticket files for 0 to 3650 days (0: keep them).
mail_mailbox_get
Section titled “mail_mailbox_get”POST /api/admin/support/mail_mailbox_get
Returns a help desk’s mailbox for importing tickets from email. The password is never returned.
Permission: Manage helpdesks (support.manage_helpdesk)
| Parameter | Type | Description |
|---|---|---|
helpdesk_id |
integer, required | The help desk id. |
Returns: helpdesk_id, enabled, host, port (default 993), encryption (ssl, tls, none), verify_tls, username, has_password, folder (default INBOX), clients_only, replies_only, max_per_run (default 25), last_run_at, last_ok, last_result, reply_to (the address ticket emails ask clients to reply to) and desk_email.
See Email to ticket.
mail_mailbox_update
Section titled “mail_mailbox_update”POST /api/admin/support/mail_mailbox_update
Saves a help desk’s IMAP mailbox for importing tickets from email.
Permission: Manage helpdesks (support.manage_helpdesk)
| Parameter | Type | Description |
|---|---|---|
helpdesk_id |
integer, required | The help desk id. |
enabled |
boolean | Import from this mailbox. Needs host, username and password. |
host |
string | The IMAP server. |
port |
integer, required | 1 to 65535, such as 993. |
encryption |
string | ssl (default), tls (STARTTLS) or none. |
verify_tls |
boolean | Check the server’s certificate. Off when left out. |
username |
string | The mailbox login. |
password |
string | Empty keeps the saved one, but only while the host, port, encryption and username stay the same. |
folder |
string | Default INBOX. |
clients_only |
boolean | New tickets only from clients and their authorized users. |
replies_only |
boolean | Only replies to existing tickets. |
max_per_run |
integer | Emails read per cron run, 1 to 200. Default 25. |
Returns: true.
Errors:
- Help desk not found.
- Choose the mail server encryption.
- The mail server host is not valid.
- The mail server port must be 1 to 65535.
- Emails per cron run must be 1 to 200.
- Mail server settings cannot hold line breaks or more than 255 characters.
- Enter the password again when the host, port, encryption or username changes.
- Enter the host, username and password before turning email import on.
Every save sets all the fields: a yes/no field you leave out is saved as off.
mail_mailbox_test
Section titled “mail_mailbox_test”POST /api/admin/support/mail_mailbox_test
Connects to a help desk’s saved mailbox and counts the emails waiting in its folder.
Permission: Manage helpdesks (support.manage_helpdesk)
| Parameter | Type | Description |
|---|---|---|
helpdesk_id |
integer, required | The help desk id. |
Returns: The number of emails in the folder.
Errors:
- Save the mailbox settings first.
- The mail server’s error message when the connection or sign-in fails
mail_import_run
Section titled “mail_import_run”POST /api/admin/support/mail_import_run
Reads every enabled mailbox now, as the cron does: each email becomes a ticket or a reply, or is logged as not imported, and is deleted from the mailbox.
Permission: Manage helpdesks (support.manage_helpdesk)
No parameters.
Returns: The number of emails handled.
A mailbox that fails is recorded on the mailbox and staff get a notification; the others still run.
mail_settings_update
Section titled “mail_settings_update”POST /api/admin/support/mail_settings_update
Saves the email import settings of the Support settings page.
Permission: Manage settings (support.manage_settings)
| Parameter | Type | Description |
|---|---|---|
mail_reply_limit |
integer | Emails one sender may send in 15 minutes, 1 to 1000. Default 10. |
mail_max_mb |
integer | Largest email in MB, 1 to 25. Default 10. |
mail_log_days |
integer | Days the import log is kept, 1 to 3650. Default 30. |
mail_insecure_imports |
boolean | Accept replies from any sender, not only the ticket’s client, users or guest. |
mail_prevent_reopen |
boolean | Do not reopen closed tickets by email. |
mail_break_lines |
string | Lines that start a quoted earlier message, one per line; empty uses the defaults. |
mail_block_senders |
string | Blocked sender addresses, one per line. |
mail_block_subjects |
string | Blocked subject words, one per line. |
mail_block_phrases |
string | Blocked phrases in the text, one per line. |
Returns: true.
Errors:
- Check the email import numbers: limits are N to N.
- Each email import list can hold up to 20,000 characters.
Every save sets all the fields: a field you leave out goes back to its default or empty.
mail_log_get_list
Section titled “mail_log_get_list”POST /api/admin/support/mail_log_get_list
Lists the email import log, newest first.
Permission: View support tickets (support.view)
| Parameter | Type | Description |
|---|---|---|
filter |
string | all (default), imported or not_imported. |
page |
integer | Page number. Default 1. |
per_page |
integer | 1 to 100. Default 25. |
Returns: {list, total, page, per_page, pages}. Each entry has id, helpdesk_id, helpdesk_name, created_at, from_email, from_name, to_email, subject, status (such as imported, replied, blocked_spam, rejected_closed, duplicate, failed), note, ticket_id, imported_by, imported_at, has_copy (a copy is kept for mail_log_import) and imported.
mail_log_import
Section titled “mail_log_import”POST /api/admin/support/mail_log_import
Imports a logged email that the checks refused, without the checks.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The log entry id. |
Returns: {status, ticket_id, note}: imported (new ticket) or replied, and the ticket.
Errors:
- Log entry not found.
- This email was imported already or its copy is gone.
- The copy of this email could not be read.
- This email was imported already (ticket #N).
- This email is being imported already.
- The email could not be imported: …
ticket_merge
Section titled “ticket_merge”POST /api/admin/support/ticket_merge
Merges tickets into the oldest one: it gets all their messages, notes and files, and the others are deleted. Only tickets of the same client, or guest tickets from the same email, can be merged.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
ids |
array, required | Two or more ticket ids (at most 50), or text such as 12, 15. |
id |
integer | One more ticket to include (the ticket page’s “merge with”). |
subject |
string | The merged ticket’s subject. Default its subject with [MERGED]. |
Returns: The id of the ticket that stays.
Errors:
- Select at least two tickets to merge.
- At most 50 tickets can be merged at once.
- Ticket #N was not found.
- Only tickets of the same client, or guest tickets from the same email address, can be merged.
- Ticket #N has a pending task. Complete it before merging.
This cannot be undone. Fires onAfterAdminTicketMerge. Emailed replies to a merged ticket’s number go to the ticket that stays.
batch_ticket_pin
Section titled “batch_ticket_pin”POST /api/admin/support/batch_ticket_pin
Pins tickets to the top of the staff ticket list.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
ids |
array, required | Ticket ids (at most 100), or a comma-separated string. |
Returns: How many of the tickets are pinned now (ids that do not exist are skipped).
Errors:
- Select at least one ticket.
- At most 100 tickets at once.
batch_ticket_unpin
Section titled “batch_ticket_unpin”POST /api/admin/support/batch_ticket_unpin
Unpins tickets.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
ids |
array, required | Ticket ids (at most 100), or a comma-separated string. |
Returns: How many tickets were pinned before.
Errors:
- Select at least one ticket.
- At most 100 tickets at once.
ticket_pinned_ids
Section titled “ticket_pinned_ids”POST /api/admin/support/ticket_pinned_ids
Returns the ids of pinned tickets, newest first.
Permission: View support tickets (support.view)
No parameters.
Returns: A list of ticket ids (at most 500).
batch_ticket_close
Section titled “batch_ticket_close”POST /api/admin/support/batch_ticket_close
Closes several tickets, as ticket_close does for each.
Permission: Manage tickets (support.manage_tickets)
| Parameter | Type | Description |
|---|---|---|
ids |
array, required | Ticket ids (at most 100), or a comma-separated string. |
Returns: How many tickets were closed (already closed ones are not counted).
Errors:
- Select at least one ticket.
- At most 100 tickets at once.
- Ticket not found (stops at that id: the tickets before it are already closed)
batch_block_delete
Section titled “batch_block_delete”POST /api/admin/support/batch_block_delete
Adds the tickets’ senders to the email import’s blocked senders, then deletes the tickets (Block Sender & Delete).
Permission: Manage tickets (support.manage_tickets) and Manage settings (support.manage_settings)
| Parameter | Type | Description |
|---|---|---|
ids |
array, required | Ticket ids (at most 100), or a comma-separated string. |
Returns: The list of addresses added to the blocked senders (your own addresses and ones already listed are skipped).
Errors:
- Select at least one ticket.
- At most 100 tickets at once.
- Ticket not found
- The blocked senders list is full (20,000 characters). Remove old entries in the email import settings first.
The sender is a guest ticket’s email, or for a client ticket the authorized user who wrote the first message, else the client’s email. This cannot be undone.
Client calls
Section titled “Client calls”ticket_get_list (client)
Section titled “ticket_get_list (client)”POST /api/client/support/ticket_get_list
Lists the signed-in client’s tickets, newest first, each with its messages.
| Parameter | Type | Description |
|---|---|---|
status |
string | open, on_hold (waiting for the client’s reply) or closed. |
search |
string | A number finds the ticket by id; text matches the subject or the messages. |
support_helpdesk_id |
integer | Tickets of one help desk. |
priority |
string | low, medium or high. |
date_from |
string | Created from this day, YYYY-MM-DD. |
date_to |
string | Created up to this day, YYYY-MM-DD. |
page |
integer | Page number, from 1. Default 1. |
per_page |
integer | Rows per page, 1 to 500. Default 100. |
Returns: A paged list of tickets, each as ticket_get returns it, without the authorized users’ names and the files on the messages.
Authorized users need the View and open support tickets permission.
ticket_get (client)
Section titled “ticket_get (client)”POST /api/client/support/ticket_get
Returns one of the client’s tickets with all its messages and their files.
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The ticket id. |
Returns: id, author_name, author_email, subject, status (open, on_hold, closed), priority_level (low, medium, high), created_at, updated_at, replies, first (the first message), helpdesk ({id, name, can_reopen}), author, client ({id, first_name, last_name}), messages (each id, content, attachment, created_at, updated_at, author {name, role} (with clientfence_user: true when an authorized user wrote it) and ticket_files ({id, name, size_label, image, removed, removed_reason})), ratings_on (reply stars are on), message_ratings (message id => stars) and, once closed, feedback_url.
Errors:
- Ticket ID was not passed
- Ticket not found (code 404)
Authorized users need the View and open support tickets permission.
Example
Request parameters:
{ "id": 21}result:
{ "id": 21, "subject": "Cannot reach my site", "status": "on_hold", "priority_level": "medium", "created_at": "2026-11-17 08:15:00", "updated_at": "2026-11-17 09:02:00", "replies": 2, "helpdesk": { "id": 1, "name": "Technical support", "can_reopen": true }, "client": { "id": 42, "first_name": "Jane", "last_name": "Doe" }, "messages": [ { "id": 57, "content": "My site example.com does not load.", "created_at": "2026-11-17 08:15:00", "author": { "name": "Jane Doe", "role": "client" }, "ticket_files": [] }, { "id": 58, "content": "Hello Jane,\n\nThe site is back online.", "created_at": "2026-11-17 09:02:00", "author": { "name": "Sam Staff", "role": "admin" }, "ticket_files": [] } ], "ratings_on": true, "message_ratings": {}}helpdesk_get_pairs (client)
Section titled “helpdesk_get_pairs (client)”POST /api/client/support/helpdesk_get_pairs
Returns the help desks a client can open a ticket in, as id and name pairs.
No parameters.
Returns: An object of help desk id => name. Help desks hidden from clients are left out.
Open to every authorized user.
ticket_create (client)
Section titled “ticket_create (client)”POST /api/client/support/ticket_create
Opens a new ticket for the signed-in client. It can also ask staff to cancel or upgrade one of the client’s orders.
| Parameter | Type | Description |
|---|---|---|
support_helpdesk_id |
integer, required | A help desk from helpdesk_get_pairs. |
subject |
string, required | The subject. |
content |
string, required | The message (Markdown), up to 100,000 characters. |
priority |
string | low, medium (default) or high. |
ticket_files |
array | Ids of files uploaded with ticket_file_upload in this session (at most 5). |
rel_type |
string | order when the ticket is about one of the client’s orders. |
rel_id |
integer | The order id. |
rel_task |
string | cancel or upgrade: a request staff mark done with admin/task_complete. |
rel_new_value |
integer | For upgrade: the product id to upgrade to. |
Returns: The new ticket’s id.
Errors:
- Ticket content required
- Ticket subject required
- Ticket support_helpdesk_id required
- Helpdesk invalid
- Support tickets are turned off.
- You have reached your limit of :limit. You can open a new ticket on :date.
- You can submit one ticket per N hours. N hours left
- The message is too long: it can have at most 100,000 characters.
- Invalid related type.
- Invalid related task.
- You do not have permission to reference this order.
- You must provide both an order ID and a new product ID in order to request an upgrade.
- We have already received this request.
Fires onBeforeClientOpenTicket and onAfterClientOpenTicket; staff get an email. When the autoresponder is on, a canned reply is posted at once. Authorized users need the View and open support tickets permission; the message shows the user’s name.
Example
Request parameters:
{ "support_helpdesk_id": 1, "subject": "Cannot reach my site", "content": "My site example.com does not load.", "priority": "high"}result:
21ticket_limit (client)
Section titled “ticket_limit (client)”POST /api/client/support/ticket_limit
Returns the client’s ticket limit, for the new ticket page’s notice.
No parameters.
Returns: null when the client has no limit; otherwise max (tickets), days, limit (both written out, such as “2 tickets in 7 days”), left (tickets the client can still open) and date (when the next one can be opened once none is left).
Open to every authorized user.
ticket_reply (client)
Section titled “ticket_reply (client)”POST /api/client/support/ticket_reply
Adds the client’s reply to a ticket. The ticket goes back to open.
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The ticket id. |
content |
string, required | The reply (Markdown), up to 100,000 characters. |
ticket_files |
array | Ids of files uploaded with ticket_file_upload in this session (at most 5). |
Returns: true.
Errors:
- Ticket ID was not passed
- Ticket content required
- Ticket not found (code 404)
- Ticket cannot be reopened.
- Support tickets are turned off.
- The message is too long: it can have at most 100,000 characters.
A closed ticket can be reopened only when its help desk allows it. Fires onAfterClientReplyTicket; staff get an email. Authorized users need the View and open support tickets permission.
ticket_close (client)
Section titled “ticket_close (client)”POST /api/client/support/ticket_close
Closes one of the client’s tickets.
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The ticket id. |
Returns: true (also when it was already closed).
Errors:
- Ticket ID was not passed
- Ticket not found (code 404)
The ticket’s secrets are removed, and the client gets the feedback request when the help desk asks for one. Fires onAfterClientCloseTicket. Authorized users need the View and open support tickets permission.
ticket_message_rate (client)
Section titled “ticket_message_rate (client)”POST /api/client/support/ticket_message_rate
Rates a staff reply of the client’s ticket from 1 to 5 stars.
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The ticket id. |
message_id |
integer, required | The staff reply. |
rating |
integer, required | 1 to 5. |
Returns: true.
Errors:
- Ticket not found (code 404)
- Reply ratings are switched off.
- Choose from 1 to 5 stars.
- Only staff replies of this ticket can be rated.
- This reply was already rated.
Each reply can be rated once. Authorized users need the View and open support tickets permission.
ticket_file_upload (client)
Section titled “ticket_file_upload (client)”POST /api/client/support/ticket_file_upload
Uploads a file for a new ticket or a reply, as a multipart form upload in the field file. Send the returned id in the message’s ticket_files.
| Parameter | Type | Description |
|---|---|---|
ticket_id |
integer | The client’s ticket the reply is for; left out for a new ticket. |
file |
mixed, required | The file (multipart form field): smaller than 10 MB, of an allowed type (guest/ticket_file_rules). |
Returns: {id, name, size, size_label}. The id is a 32-character string.
Errors:
- Ticket not found
- Choose a file to attach.
- You attached many files in the last hour. Please try again later. (30 an hour)
- Send your message first: at most 10 files can wait to be sent.
- Each file must be smaller than 10 MB.
- This type of file cannot be attached. Allowed: …
The file waits in this browser session until a message sends it; one that is never sent is removed after a day. Authorized users need the View and open support tickets permission.
ticket_file_discard (client)
Section titled “ticket_file_discard (client)”POST /api/client/support/ticket_file_discard
Throws away a file uploaded in this session that was not sent yet.
| Parameter | Type | Description |
|---|---|---|
id |
string | The upload id. |
Returns: true.
Errors:
- File not found
Authorized users need the View and open support tickets permission.
ticket_secret_kinds (client)
Section titled “ticket_secret_kinds (client)”POST /api/client/support/ticket_secret_kinds
Tells which kinds of ticket secrets clients may add, and how long they are kept.
No parameters.
Returns: {server, other, days}: server logins on or off, other secrets on or off, and the days a secret is kept (1 to 90, default 7).
See Ticket secrets. Authorized users need the View and open support tickets permission.
ticket_secret_add (client)
Section titled “ticket_secret_add (client)”POST /api/client/support/ticket_secret_add
Adds an encrypted secret (a server login or another secret) to one of the client’s open tickets. It is kept apart from the messages and never emailed.
| Parameter | Type | Description |
|---|---|---|
ticket_id |
integer, required | The ticket id. |
kind |
string, required | server or other. |
host |
string | For server (needed): the server host, up to 255 characters. |
type |
string | For server (needed): ssh, panel or other. |
username |
string | For server: the login, up to 255 characters. |
password |
string | For server: up to 1000 characters. A password or an SSH key is needed. |
ssh_key |
string | For server: up to 20,000 characters. |
port |
integer | For server: 1 to 65535. |
note |
string | For server: up to 2000 characters. |
label |
string | For other (needed): up to 100 characters. |
value |
string | For other (needed): up to 5000 characters. |
Returns: {id}: the new secret’s id.
Errors:
- Ticket not found
- Secrets cannot be added to a closed ticket.
- Choose a valid kind of secret.
- This kind of secret is turned off.
- At most 10 secrets can be added to a ticket.
- Enter the server host.
- Choose a valid server access type.
- Enter a password or an SSH key.
- The port must be between 1 and 65535.
- Enter a label and a value for the secret.
- The :field field must be at most :max characters.
- This secret is too large.
A secret is deleted when the ticket closes or after the days ticket_secret_kinds gives. Authorized users need the View and open support tickets permission.
ticket_secret_list (client)
Section titled “ticket_secret_list (client)”POST /api/client/support/ticket_secret_list
Lists the secrets of one of the client’s tickets (labels only) and who opened or deleted them.
| Parameter | Type | Description |
|---|---|---|
ticket_id |
integer, required | The ticket id. |
Returns: secrets ({id, kind, label, created_at}) and events ({action, label, staff_name, created_at}; action opened, deleted or expired).
Errors:
- Ticket not found
Authorized users need the View and open support tickets permission.
ticket_secret_delete (client)
Section titled “ticket_secret_delete (client)”POST /api/client/support/ticket_secret_delete
Deletes a secret from one of the client’s tickets.
| Parameter | Type | Description |
|---|---|---|
id |
integer, required | The secret id. |
Returns: true.
Errors:
- Secret ID was not passed
- Ticket not found (the secret does not exist)
Authorized users need the View and open support tickets permission.
network_issue_alerts (client)
Section titled “network_issue_alerts (client)”POST /api/client/support/network_issue_alerts
Returns the network issues and planned work that affect the client, for the client area’s banner.
No parameters.
Returns: A list of up to 10 issues, soonest first, each as admin/network_issue_get returns it without created_by, emailed_at and emailed_count. Empty while the Network Status page is off or the client has no active or suspended service.
An issue counts while it is not resolved, or while planned work has not ended. A server issue counts only for clients with a hosting service on that server. Open to every authorized user.
Guest calls
Section titled “Guest calls”ticket_create (guest)
Section titled “ticket_create (guest)”POST /api/guest/support/ticket_create
Opens a ticket for a visitor who is not signed in. The visitor follows it with the returned hash.
| Parameter | Type | Description |
|---|---|---|
name |
string, required | The visitor’s name. |
email |
string, required | The visitor’s email. |
subject |
string, required | The subject. |
content |
string, required | The message (Markdown), 4 to 100,000 characters. message is read when content is missing (deprecated). |
support_helpdesk_id |
integer | A help desk from helpdesk_get_pairs. Default the first one visitors see. |
priority |
string | low, medium (default) or high. |
Returns: The ticket’s access hash (a hex string), for ticket_get, ticket_reply and ticket_close.
Errors:
- Please enter your name
- Please enter your email address
- Please enter the subject
- Please enter your message
- Rate limit exceeded. Please try again later. (code 429)
- We currently aren’t accepting support tickets from unregistered users. Please use another contact method.
- Helpdesk invalid
- The message is too long: it can have at most 100,000 characters.
Three tickets an hour from one IP address. Fires onBeforeClientOpenTicket and onAfterClientOpenTicket. The access hash works like a password: anyone who has it can read and answer the ticket.
Example
Request parameters:
{ "name": "Alex Visitor", "email": "alex@example.com", "subject": "Question before I order", "content": "Do your plans include daily backups?"}result:
"3f9a1c0e7b52d84a6e1f09c3b7d2a5e8"ticket_get (guest)
Section titled “ticket_get (guest)”POST /api/guest/support/ticket_get
Returns a guest ticket by its access hash, with all its messages.
| Parameter | Type | Description |
|---|---|---|
hash |
string, required | The access hash ticket_create returned. |
Returns: The fields of client/ticket_get and hash, without files and authorized users’ names.
Errors:
- Ticket hash required
- Guest ticket not found
ticket_close (guest)
Section titled “ticket_close (guest)”POST /api/guest/support/ticket_close
Closes a guest ticket.
| Parameter | Type | Description |
|---|---|---|
hash |
string, required | The ticket’s access hash. |
Returns: true (also when it was already closed).
Errors:
- Ticket hash required
- Guest ticket not found
Sends the feedback request when the help desk asks for one. Fires onAfterClientCloseTicket.
ticket_message_rate (guest)
Section titled “ticket_message_rate (guest)”POST /api/guest/support/ticket_message_rate
Rates a staff reply of a guest ticket from 1 to 5 stars.
| Parameter | Type | Description |
|---|---|---|
hash |
string, required | The ticket’s access hash. |
message_id |
integer, required | The staff reply. |
rating |
integer, required | 1 to 5. |
Returns: true.
Errors:
- Guest ticket not found
- Reply ratings are switched off.
- Choose from 1 to 5 stars.
- Only staff replies of this ticket can be rated.
- This reply was already rated.
ticket_feedback_submit (guest)
Section titled “ticket_feedback_submit (guest)”POST /api/guest/support/ticket_feedback_submit
Saves the feedback form that the feedback email links to: a score for each staff member who replied, and comments.
| Parameter | Type | Description |
|---|---|---|
token |
string, required | The token of the feedback link. |
rate |
object | Staff id => score from 1 to 10, one for each staff member who replied (needed for each). |
comments |
object | Staff id => comment, and generic => a comment on the support as a whole; up to 5000 characters each. generic is needed when no staff member replied. |
Returns: true.
Errors:
- This feedback link is not valid.
- Feedback can be given once the ticket is closed.
- Rate :name from 1 to 10.
- Tell us how we can improve.
- A comment can be at most 5000 characters.
- Feedback for this ticket was already given. Thank you.
Feedback is given once per ticket. A score of 4 or lower notifies staff. See Feedback.
ticket_reply (guest)
Section titled “ticket_reply (guest)”POST /api/guest/support/ticket_reply
Adds the visitor’s reply to a guest ticket. The ticket goes back to open.
| Parameter | Type | Description |
|---|---|---|
hash |
string, required | The ticket’s access hash. |
content |
string, required | The reply (Markdown), up to 100,000 characters. message is read when content is missing (deprecated). |
Returns: The new message’s id.
Errors:
- Ticket hash required
- Guest ticket not found
- Ticket cannot be reopened.
- Message cannot be empty
- Support tickets are turned off.
- The message is too long: it can have at most 100,000 characters.
A closed ticket can be reopened only when its help desk allows it. Fires onAfterClientReplyTicket.
guest_tickets_enabled (guest)
Section titled “guest_tickets_enabled (guest)”POST /api/guest/support/guest_tickets_enabled
Tells whether visitors who are not signed in may open tickets.
No parameters.
Returns: true or false (also false while tickets are turned off).
tickets_enabled (guest)
Section titled “tickets_enabled (guest)”POST /api/guest/support/tickets_enabled
Tells whether tickets are turned on in the Support settings. While off, clients and guests can neither open nor answer tickets.
No parameters.
Returns: true or false.
support_url (guest)
Section titled “support_url (guest)”POST /api/guest/support/support_url
Returns the outside help desk address that the Support links open while tickets are turned off.
No parameters.
Returns: The address, or null while tickets are on or when none is set.
public_tickets_enabled (guest)
Section titled “public_tickets_enabled (guest)”POST /api/guest/support/public_tickets_enabled
Deprecated: use guest_tickets_enabled, which this returns.
No parameters.
Returns: true or false.
ticket_priorities (guest)
Section titled “ticket_priorities (guest)”POST /api/guest/support/ticket_priorities
Returns the ticket priorities for a new ticket form’s urgency choice, in the visitor’s language.
No parameters.
Returns: {high, medium, low}: key => name.
Example
Request parameters:
{}result:
{ "high": "High", "medium": "Medium", "low": "Low"}helpdesk_get_pairs (guest)
Section titled “helpdesk_get_pairs (guest)”POST /api/guest/support/helpdesk_get_pairs
Returns the help desks visitors can open a ticket in, as id and name pairs.
No parameters.
Returns: An object of help desk id => name. Help desks hidden from clients are left out.
kb_enabled (guest)
Section titled “kb_enabled (guest)”POST /api/guest/support/kb_enabled
Tells whether the knowledge base is turned on.
No parameters.
Returns: true or false.
kb_suggestions_enabled (guest)
Section titled “kb_suggestions_enabled (guest)”POST /api/guest/support/kb_suggestions_enabled
Tells whether a form suggests knowledge base articles while the visitor types.
| Parameter | Type | Description |
|---|---|---|
area |
string | contact (the contact form) or ticket (the new ticket form). |
Returns: true or false (false for any other area, or while the knowledge base is off).
kb_article_views_enabled (guest)
Section titled “kb_article_views_enabled (guest)”POST /api/guest/support/kb_article_views_enabled
Tells whether article view counts are shown to visitors.
No parameters.
Returns: true or false.
kb_article_get_list (guest)
Section titled “kb_article_get_list (guest)”POST /api/guest/support/kb_article_get_list
Lists the published knowledge base articles.
| Parameter | Type | Description |
|---|---|---|
search |
string | Words to find in the title, text or category. |
kb_article_category_id |
integer | Articles of one category. |
page |
integer | Page number, from 1. Default 1. |
per_page |
integer | Rows per page, 1 to 500. Default 100. |
Returns: A paged list. Each row has id, slug, title, views (only when view counts are shown), status, created_at, updated_at and category ({id, slug, title}).
Errors:
- Knowledge Base is disabled
Articles of categories hidden from clients are left out. See Knowledge base.
kb_article_get (guest)
Section titled “kb_article_get (guest)”POST /api/guest/support/kb_article_get
Returns a published knowledge base article by id or slug, and counts one view.
| Parameter | Type | Description |
|---|---|---|
id |
integer | The article id (or send slug). |
slug |
string | The article slug. |
Returns: The fields of a kb_article_get_list row and content (Markdown).
Errors:
- Knowledge Base is disabled
- ID or slug is missing
- Article item not found (code 404)
kb_category_get_list (guest)
Section titled “kb_category_get_list (guest)”POST /api/guest/support/kb_category_get_list
Lists the knowledge base categories by title, each with its published articles.
| Parameter | Type | Description |
|---|---|---|
q |
string | Words to find in category or article titles and texts; each category then shows only matching articles. |
page |
integer | Page number, from 1. Default 1. |
per_page |
integer | Rows per page, 1 to 500. Default 100. |
Returns: A paged list. Each row has id, title, description, slug, created_at, updated_at and articles (as in kb_article_get_list).
Errors:
- Knowledge Base is disabled
Categories hidden from clients, and categories without published articles, are left out.
kb_category_get (guest)
Section titled “kb_category_get (guest)”POST /api/guest/support/kb_category_get
Returns a knowledge base category by id or slug, with its articles.
| Parameter | Type | Description |
|---|---|---|
id |
integer | The category id (or send slug). |
slug |
string | The category slug. |
Returns: id, title, description, slug, created_at, updated_at, articles.
Errors:
- Knowledge Base is disabled
- Category ID or slug is missing
- Knowledge Base category not found (code 404)
ticket_file_rules (guest)
Section titled “ticket_file_rules (guest)”POST /api/guest/support/ticket_file_rules
Returns what ticket attachments allow, for an upload field.
No parameters.
Returns: extensions (list), accept (such as .jpg,.png,... for a file input), max_files (5 per message), max_bytes and max_mb (10).
Example
Request parameters:
{}result:
{ "extensions": [ "jpg", "jpeg", "png", "gif", "pdf", "txt", "log", "csv", "zip", "rar", "tar" ], "accept": ".jpg,.jpeg,.png,.gif,.pdf,.txt,.log,.csv,.zip,.rar,.tar", "max_files": 5, "max_bytes": 10485760, "max_mb": 10}network_status_settings (guest)
Section titled “network_status_settings (guest)”POST /api/guest/support/network_status_settings
Tells whether the Network Status page is on, and whether visitors who are not signed in may read it.
No parameters.
Returns: {enabled, public}.
network_issues (guest)
Section titled “network_issues (guest)”POST /api/guest/support/network_issues
Returns one tab of the Network Status page: current issues, planned work or resolved issues.
| Parameter | Type | Description |
|---|---|---|
group |
string | open (default), scheduled or resolved. |
page |
integer | Page number. Default 1. |
Returns: {list, total, page, per_page, pages, counts}, 10 issues a page. Each issue as admin/network_issue_get returns it without created_by, emailed_at and emailed_count; counts is {open, scheduled, resolved}.
Errors:
- Network status is not available. (code 404)
- Sign in to see the network status. (code 403)
See Network status.

