Skip to main content
PUT
Update 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.

Path Parameters

ticket_id
string
required

ID of the ticket. You can use either the ticket ID (UUID) or ticket number (sequential number) interchangeably. Refer to Getting Ticket ID section for detailed instructions.

Body

application/json
email
string

Email address of the customer.

Example:

"john@example.com"

subject
string

Subject for the ticket.

Example:

"How to resolve the pending payments"

description
string

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:
attachments
string[]

Signed ids returned by Upload attachment or Reserve an attachment upload. The files are added to the ticket's opening message, alongside whatever it already carries. A signed id minted in another workspace is rejected, and so is one whose file was reserved but never sent. Attachments are all-or-nothing: if any id in the array is unknown, malformed, unsent or from another workspace, the whole request fails and nothing is attached. A ticket with no opening message cannot take attachments this way; add the file with a comment instead. Attaching applies the workspace attachment limit, 10 MB by default, which is smaller than the 50 MB upload limit.

Example:
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:

"closed"

priority
enum<string>

Priority for the ticket.

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

"urgent"

category
string

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

Example:

"Problem"

sub_category_one
string

Sub-category for the ticket.

Example:

"Billing"

sub_category_two
string

Second-level sub-category for the ticket.

Example:

"Refund"

group
string

Name of an existing group. An unknown name is rejected.

Example:

"sales"

assignee_email
string<email>

Email address belonging to a team member who can be assigned tickets. An unknown email is rejected.

Example:

"oliver@example.com"

tags
string[]

Tags to assign to the ticket. Replaces every tag the ticket has. Cannot be combined with add_tags or remove_tags.

Example:
add_tags
string[]

Tags to add, keeping the ticket's existing tags.

Example:
remove_tags
string[]

Tags to remove, keeping the ticket's other tags. Matched without regard to case.

Example:
resolution_due_date
string<date-time>

Resolution due date for the ticket.

Example:

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

Response

OK - Request succeeded

ticket
object