Skip to main content
POST
Open a ticket

Authorizations

Authorization
string
header
required

Send your API token as Authorization: Bearer <api-token>.

Query Parameters

teamID
string

Run the request in the context of a team you belong to, instead of your personal account. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
subject
string
required

At most 9 words.

body
string
required

The first message.

category
enum<string>
required
Available options:
TECHNICAL,
BILLING,
MIGRATION,
REPORT,
FEEDBACK
codeReview
boolean
required

Whether support may look at your code to help.

attachments
string[]

Attachment IDs from POST /v1/attachments.

Maximum array length: 3
projects
string[]

IDs (_id) of the apps the ticket is about.

databases
string[]

IDs of the databases the ticket is about.

domains
string[]

IDs of the domains the ticket is about.

buckets
string[]

IDs of the object storage buckets the ticket is about.

zones
string[]

IDs of the DNS zones the ticket is about.

mailServers
string[]

IDs of the mail servers the ticket is about.

vms
string[]

IDs of the virtual machines the ticket is about.

ais
string[]

IDs of the AI workspaces the ticket is about.

Response

The ticket was opened. The response can include additional fields not listed here.

_id
string
shortID
integer
subject
string
status
enum<string>

OPEN: waiting for support. ANSWERED: support replied. PENDING: support is working on it. UPGRADE_REQUIRED: support says it needs a plan upgrade. CLOSED: closed.

Available options:
OPEN,
ANSWERED,
PENDING,
UPGRADE_REQUIRED,
CLOSED
category
enum<string>
Available options:
TECHNICAL,
BILLING,
MIGRATION,
REPORT,
FEEDBACK
codeReview
boolean
user
string

ID of the account that owns the ticket.

actor
string

For team tickets, ID of the person who opened it.

projects
string[]
databases
string[]
domains
string[]
buckets
string[]
zones
string[]
mailServers
string[]
vms
string[]
ais
string[]
subscriptionPlan
string

ID of the account's subscription plan when the ticket was opened.

created_at
string<date-time>
updated_at
string<date-time>