HTTP routes · /api/helpdesk
Helpdesk route reference
77 operations. Every staff and customer route Helpdesk registers, with its capability, inputs, and responses. Capabilities, query parameters, and body fields are read from the plugin's own handlers.
https://your-site.example/api/helpdeskRead the introduction first for sessions, errors, and rate limits.
Operations
Tickets
Ticket actions
- POST
/tickets/{id}/repliesReply to a ticket - POST
/tickets/{id}/assignAssign a ticket - POST
/tickets/{id}/handoverHand over a ticket - POST
/tickets/{id}/visibilitySet ticket visibility - GET
/tickets/{id}/redactPreview a redaction - POST
/tickets/{id}/redactRedact text - POST
/tickets/{id}/suggestSuggest a reply - POST
/tickets/{id}/tagsAdd a tag - POST
/tickets/{id}/untagRemove a tag - POST
/tickets/{id}/followersAdd a follower - POST
/tickets/{id}/unfollowRemove a follower - POST
/tickets/{id}/mergeMerge tickets - POST
/tickets/{id}/splitSplit a ticket - POST
/tickets/{id}/linksLink tickets - POST
/tickets/{id}/articleSave as article
Files and secrets
People
Desk
- GET
/categoriesList categories - POST
/categoriesCreate a category - GET
/setupGet desk setup - PATCH
/categories/{id}Rename a category - DEL
/categories/{id}Delete a category - POST
/teamsCreate a team - PATCH
/teams/{id}Rename a team - DEL
/teams/{id}Delete a team - GET
/cannedList canned replies - POST
/cannedCreate a canned reply - PATCH
/canned/{id}Update a canned reply - DEL
/canned/{id}Delete a canned reply - POST
/viewsCreate a saved view - PATCH
/views/{id}Update a saved view - DEL
/views/{id}Delete a saved view - POST
/fieldsCreate a custom field - PATCH
/fields/{id}Update a custom field - DEL
/fields/{id}Delete a custom field - POST
/slaCreate an SLA target - PATCH
/sla/{id}Update an SLA target - DEL
/sla/{id}Delete an SLA target - POST
/automationsCreate an automation - PATCH
/automations/{id}Update an automation - DEL
/automations/{id}Delete an automation
Reports
Settings
Network
Shop
Customer portal
- POST
/portal/unsubscribeStop reminder mail - GET
/portal/ticketsList my tickets - POST
/portal/ticketsOpen a ticket - GET
/portal/profileGet the visitor's profile - GET
/portal/formGet the support form - GET
/portal/captchaGet the CAPTCHA settings - POST
/portal/tickets/{id}/plusAdd a +1 - POST
/portal/ordersLook up an order - POST
/portal/tickets/{id}/attachmentsAttach a file as the customer - POST
/portal/tickets/{id}/secrets/{secretId}/revealReveal my sensitive message - GET
/portal/tickets/{id}Get my ticket - POST
/portal/tickets/{id}/repliesReply as the customer - GET
/portal/archiveSearch public tickets - POST
/portal/findFind a request - POST
/portal/tickets/{id}/statusClose or reopen my ticket - POST
/portal/tickets/{id}/csatRate my ticket