Support

POST /api/support/abuse

Public abuse report

• Access: No authentication

GET /api/support/abuse/config

Abuse form availability

• Access: No authentication

GET /api/support/articles

Help articles

• Access: Signed-in user (browser session)

POST /api/support/articles

Write or update article

• Access: Administrator

GET /api/support/articles/{slug}

Read article

• Access: Signed-in user (browser session)
• Path parameters: slug

DELETE /api/support/articles/{slug}

Delete article

• Access: Administrator
• Path parameters: slug

POST /api/support/articles/{slug}/vote

Vote on article helpfulness

• Access: Signed-in user (browser session)
• Path parameters: slug

POST /api/support/categories

Create category

• Access: Administrator

PUT /api/support/categories/{id}

Edit category

• Access: Administrator
• Path parameters: id

GET /api/support/config

Available categories and support tier

• Access: Signed-in user (browser session)

GET /api/support/diagnostics/{id}

Preview redacted server diagnostics

• Access: Signed-in user (browser session)
• Path parameters: id

GET /api/support/drafts/{id}

Read your draft

• Access: Signed-in user (browser session)
• Path parameters: id

PUT /api/support/drafts/{id}

Save your draft

• Access: Signed-in user (browser session)
• Path parameters: id

POST /api/support/groups

Create agent group

• Access: Administrator

PUT /api/support/groups/{id}

Edit agent group

• Access: Administrator
• Path parameters: id

PUT /api/support/hours

Set business hours and holidays

• Access: Administrator

POST /api/support/inbound

Signed inbox bridge for email replies

• Access: No authentication

POST /api/support/inbound/secret

Rotate the encrypted inbox bridge secret; shown once

• Access: Administrator

GET /api/support/inbound/settings

Read whether the signed inbox bridge is enabled

• Access: Administrator

PUT /api/support/inbound/settings

Enable or disable signed inbound replies

• Access: Administrator
• Body: enabled:boolean

GET /api/support/macros

List available macros

• Access: Administrator

POST /api/support/macros

Create macro

• Access: Administrator

DELETE /api/support/macros/{id}

Delete macro

• Access: Administrator
• Path parameters: id

GET /api/support/public

Public articles

• Access: No authentication

GET /api/support/reports

Thirty-day support report

• Access: Administrator

POST /api/support/rules

Create automation rule

• Access: Administrator

PUT /api/support/rules/{id}

Enable or reorder automation

• Access: Administrator
• Path parameters: id

DELETE /api/support/rules/{id}

Delete automation

• Access: Administrator
• Path parameters: id

GET /api/support/search

Search articles

• Access: Signed-in user (browser session)

GET /api/support/settings

Desk configuration

• Access: Administrator

PUT /api/support/settings

Enable and configure desk

• Access: Administrator

GET /api/support/tickets

List tickets

• Access: Signed-in user (browser session)

POST /api/support/tickets

Create ticket

• Access: Signed-in user (browser session)

GET /api/support/tickets/{id}

Ticket thread

• Access: Signed-in user (browser session)
• Path parameters: id

PATCH /api/support/tickets/{id}

Update ticket

• Access: Signed-in user (browser session)
• Path parameters: id

DELETE /api/support/tickets/{id}

Delete ticket

• Access: Administrator
• Path parameters: id

POST /api/support/tickets/{id}/attachments

Upload attachment

• Access: Signed-in user (browser session)
• Path parameters: id

GET /api/support/tickets/{id}/attachments/{attachmentId}

Download attachment

• Access: Signed-in user (browser session)
• Path parameters: id, attachmentId

POST /api/support/tickets/{id}/messages

Post reply or internal note

• Access: Signed-in user (browser session)
• Path parameters: id

POST /api/support/tickets/{id}/rating

Rate support

• Access: Signed-in user (browser session)
• Path parameters: id

POST /api/support/tickets/{id}/reopen

Reopen ticket

• Access: Signed-in user (browser session)
• Path parameters: id

POST /api/support/tickets/bulk

Bulk assignment and status updates

• Access: Administrator

PUT /api/support/tiers/{id}

Update business-hour goals

• Access: Administrator
• Path parameters: id