Skip to main content
POST
Create ticket
Requires Premium or Enterprise subscription

Overview

Create a new support ticket. The author does not need to be a workspace member unless the category requires it. Author Information:
  • authorUserId is required
  • authorAvatarUrl is required
  • authorUsername and authorDisplayName are optional but recommended for users not in the database

Request Body

string
required
Ticket subject/title
string
required
Category ID (must exist in workspace configuration)
string
required
Initial message content
string
Ticket priority: low, medium, high, urgent (default: medium)
integer
required
UserId of the ticket creator
string
Username of the author (used if not in database)
string
Display name of the author (used if not in database)
string
required
Avatar URL of the ticket author

Response

boolean
Whether the request was successful
object

Example

Response Example

Error Responses

Rate Limit

25 requests per second per API key

Authorizations

apikey
string
header
required

Pass your API key in the apikey header. Alternatively, the x-api-key header is also accepted.

Body

application/json
subject
string
required

Ticket subject

category
string
required

Category ID

message
string
required

Initial message content

authorUserId
integer
required

UserId of the ticket creator

authorAvatarUrl
string
required

Avatar URL of the ticket author

priority
enum<string>
default:medium
Available options:
low,
medium,
high,
urgent
authorUsername
string

Username of the author

authorDisplayName
string

Display name of the author

Response

Ticket created successfully