Skip to main content
POST
Create a ticket
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Body

application/json
email
string
required

Email address of the customer.

Example:

"john@example.com"

subject
string
required

Subject for the ticket.

Example:

"How to resolve the pending payments"

description
string
required

Description for the ticket.

Example:

"I need your help in resolving the pending payments."

ticket_fields
object

Custom ticket fields. Refer to the ticket fields article for more details.

Example:
name
string

Name of the customer.

Example:

"John Luther"

channel
enum<string>

Source of the ticket. Defaults to api if not specified or if an invalid channel is provided.

Available options:
email,
ui,
twitter,
chat,
form,
api,
whatsapp,
telephony
Example:

"email"

to
string

Array of additional emails to be added to the to field of any responses from the ticket.

Example:

"[\"eve@example.com\",\"kevin@example.com\"]"

cc
string

Array of emails to be added to the cc field of any responses from the ticket.

Example:

"[\"eve@example.com\",\"kevin@example.com\"]"

group
string

Name of an existing group.

Example:

"sales"

assignee_email
string<email>

Email address belonging to a team member.

Example:

"oliver@example.com"

status
string

Status for the ticket. Default statuses include new, open, on_hold, waiting_on_customer, closed, spam, trash. Custom statuses are also supported.

Example:

"open"

priority
enum<string>

Priority for the ticket.

Available options:
low,
medium,
high,
urgent
Example:

"low"

category
string

Category for the ticket. Default categories include None, Questions, Incident, Problem, Feature request, Refund. Custom categories are also supported.

Example:

"Questions"

sub_category_one
string

Sub-category for the ticket.

Example:

"Billing"

sub_category_two
string

Second-level sub-category for the ticket.

Example:

"Refund"

tags
string[]

Tags to assign to the ticket.

Example:
resolution_due_date
string<date-time>

Resolution due date for the ticket.

Example:

"2025-12-31T23:59:59Z"

Response

201 - application/json

Created - Ticket created successfully

ticket
object