/
SP
sparkvault
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
account
6
analytics
6
api-keys
3
apps
22
audit-logs
1
auth
5
billing
20
config
1
domains
8
entropy
2
files
5
hd
29
health
2
help-desk
76
post
/products/help-desk/activate
Activate the help desk
get
/products/help-desk/analytics
Read the help desk analytics
get
/products/help-desk/analytics/export.csv
Download the help desk analytics as CSV
delete
/products/help-desk/attachments/{attachment_id}
Delete an attachment
get
/products/help-desk/attachments/{attachment_id}/download
Download an attachment
post
/products/help-desk/deactivate
Deactivate the help desk
get
/products/help-desk/healthz
get
/products/help-desk/jobs/{job_id}
Read a job
get
/products/help-desk/knowledge-base
Read the knowledge base workspace
get
/products/help-desk/knowledge-base/analytics
Read knowledge base activity for a date range
post
/products/help-desk/knowledge-base/articles
Create an article draft
get
/products/help-desk/knowledge-base/articles/{article_id}
Read an article draft
put
/products/help-desk/knowledge-base/articles/{article_id}
Save a new article revision
delete
/products/help-desk/knowledge-base/articles/{article_id}
Archive an unpublished article
post
/products/help-desk/knowledge-base/articles/{article_id}/restore
Restore a revision as a new draft
get
/products/help-desk/knowledge-base/articles/{article_id}/revisions
List immutable article revisions
get
/products/help-desk/knowledge-base/articles/{article_id}/revisions/{revision_id}
Read a saved article revision
get
/products/help-desk/knowledge-base/assets
List private knowledge base images
post
/products/help-desk/knowledge-base/assets
Upload a private knowledge base image
get
/products/help-desk/knowledge-base/assets/{asset_id}/content
Preview a private knowledge base image
post
/products/help-desk/knowledge-base/categories
Create a knowledge base category
put
/products/help-desk/knowledge-base/categories/{category_id}
Update a category
delete
/products/help-desk/knowledge-base/categories/{category_id}
Delete an empty category
post
/products/help-desk/knowledge-base/disable
Disable the public knowledge base
post
/products/help-desk/knowledge-base/enable
Enable the public knowledge base
post
/products/help-desk/knowledge-base/publication/cancel
Cancel a pending publication
post
/products/help-desk/knowledge-base/publication/retry
Retry a pending publication
post
/products/help-desk/knowledge-base/publish
Publish selected saved article revisions
put
/products/help-desk/knowledge-base/settings
Save knowledge base appearance and SEO
get
/products/help-desk/legal-holds
List the tickets under legal hold
get
/products/help-desk/operators
List the desk's operators
get
/products/help-desk/operators/me
Read your desk preferences
put
/products/help-desk/operators/me
Change your desk preferences
post
/products/help-desk/operators/me/avatar-handle/rotate
Retire your avatar address
put
/products/help-desk/operators/{user_id}/training
Set an operator training assignment
get
/products/help-desk/reply-reviews
Read private reply reviews
get
/products/help-desk/requesters/{requester_id}
Read a requester
post
/products/help-desk/requesters/{requester_id}/block
Block a requester
post
/products/help-desk/requesters/{requester_id}/erase
Erase a requester's data
post
/products/help-desk/requesters/{requester_id}/export
Export a requester's data
post
/products/help-desk/requesters/{requester_id}/unblock
Unblock a requester
get
/products/help-desk/routing-rules
List the routing rules
put
/products/help-desk/routing-rules
Save the routing rules
post
/products/help-desk/routing-rules/apply
Apply the routing rules to existing tickets
post
/products/help-desk/routing-rules/test
Test routing rules against a sample
get
/products/help-desk/saved-replies
List saved replies
post
/products/help-desk/saved-replies
Save a reply
delete
/products/help-desk/saved-replies/{saved_reply_id}
Delete a saved reply
patch
/products/help-desk/saved-replies/{saved_reply_id}
Change a saved reply
get
/products/help-desk/settings
Read the help desk settings
put
/products/help-desk/settings
Change the help desk settings
get
/products/help-desk/settings/status
Read the help desk status
get
/products/help-desk/teams
List the teams with their help desk settings
put
/products/help-desk/teams/{team_id}
Change a team's help desk settings
get
/products/help-desk/tickets
List the queue
post
/products/help-desk/tickets/bulk
Change several tickets
get
/products/help-desk/tickets/counts
Read the queue counts
get
/products/help-desk/tickets/{ticket_id}
Read a ticket
patch
/products/help-desk/tickets/{ticket_id}
Change a ticket
post
/products/help-desk/tickets/{ticket_id}/attachments/initiate
Start an attachment upload
delete
/products/help-desk/tickets/{ticket_id}/attachments/{attachment_id}
Cancel an attachment upload
post
/products/help-desk/tickets/{ticket_id}/claim
Claim a ticket
get
/products/help-desk/tickets/{ticket_id}/events
Read a ticket's timeline
post
/products/help-desk/tickets/{ticket_id}/held/{held_id}/discard
Discard a held email
post
/products/help-desk/tickets/{ticket_id}/held/{held_id}/release
Release a held email
put
/products/help-desk/tickets/{ticket_id}/legal-hold
Place or clear a legal hold
post
/products/help-desk/tickets/{ticket_id}/merge
Merge a ticket into another
post
/products/help-desk/tickets/{ticket_id}/notes
Add an internal note
put
/products/help-desk/tickets/{ticket_id}/presence
Say you are on a ticket
post
/products/help-desk/tickets/{ticket_id}/replies
Reply to the customer
post
/products/help-desk/tickets/{ticket_id}/reply-reviews/{review_id}/approve
Approve and send a held reply
post
/products/help-desk/tickets/{ticket_id}/reply-reviews/{review_id}/discard
Discard a held reply without sending it
post
/products/help-desk/tickets/{ticket_id}/reply-reviews/{review_id}/reassign
Reassign a held reply to another manager
post
/products/help-desk/tickets/{ticket_id}/reply-reviews/{review_id}/reject
Return a held reply with feedback
post
/products/help-desk/tickets/{ticket_id}/reply-reviews/{review_id}/resubmit
Resubmit a rewritten reply
post
/products/help-desk/tickets/{ticket_id}/unmerge
Undo a merge
identity
101
me
10
messaging
18
notify
15
profile
3
push-tokens
2
settings
2
sparklinks
3
sparks
9
structured-ingots
6
teams
6
unsubscribe
2
users
9
vaults
48
help-desk
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to GET /products/help-desk/healthz
get
/products/help-desk/healthz
Oct 22, 2026
f5ac9c809ef7
Revision changes
info
endpoint added