Skip to content

Create a support ticket

POST
/v1/support/tickets
curl --request POST \
--url https://shareout.site/v1/support/tickets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "subject": "example", "body": "example", "workspaceId": "example", "category": "bug", "severity": "low", "client": "ui", "requestId": "example", "pageUrl": "example", "artifactId": "example", "userAgent": "example", "idempotencyKey": "example", "locale": "en" }'
Media typeapplication/json
object
subject
required
string
body
required
string
workspaceId

Must be a workspace the caller belongs to (else 403).

string
nullable
category
string
Allowed values: bug question access billing other
severity
string
Allowed values: low normal high blocker
client
string
Allowed values: ui claude chatgpt mcp api slack telegram email chat_agent
requestId

Request_id from the error response that led here.

string
pageUrl
string
artifactId
string
userAgent
string
idempotencyKey

Same key from the same account returns the original ticket (200, deduped=true).

string
locale
string
Allowed values: en es

Duplicate idempotencyKey — the original ticket

Created

Media typeapplication/json
object
success
boolean
ticket
object
id
string
subject
string
status
string
Allowed values: open pending resolved closed
channel
string
Allowed values: ui skill email telegram slack
workspace_id
string
nullable
requester_user_id
string
nullable
requester_email
string format: email
nullable
priority
string
nullable
created_at
string format: date-time
updated_at
string format: date-time
Example
{
"ticket": {
"status": "open",
"channel": "ui"
}
}

Invalid request

Media typeapplication/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string
reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string
hint

What to do next, in plain words.

string
suggestion
string
param

The request field at fault.

string
docs

Doc page for this error.

string
redirect_url
string
support

Present on 5xx — how to reach a human.

object
how
string
include
Array<string>
Example
{
"success": false,
"support": {
"how": "POST /v1/support/tickets",
"include": [
"request_id"
]
}
}