Skip to main content
Tickets

Update a ticket

Updates a ticket's properties. Only provided fields will be updated.

PATCH
/v2/tickets/{id}

Path Parameters

  • id - The ticket number

Request Body

All fields are optional.

FieldTypeDescription
titlestringUpdate title
contentstringUpdate description (HTML)
statusIdstringSet status by ID
openbooleanClose (false) or reopen (true) the ticket
assigneeIdstring/nullAssign/unassign admin
companyIdstring/nullUpdate company association
customFieldsobjectUpdate custom field values
snoozedUntilstring/nullSnooze until ISO 8601 timestamp (null to unsnooze)
skipNotificationsbooleanSkip notifications (default false)

Closing a Ticket

Set open: false to close the ticket. Closing a ticket will also unsnooze it. The status is not changed automatically — use statusId to change the status explicitly.

File Custom Fields

File-type custom fields support the same two upload methods as ticket creation: multipart upload (customFields.<fieldId> file parts with JSON in the data field) and external URLs ({ "url": "https://..." } with optional "name" in the custom field value). Same limits apply (10 files, 400MB total, executable types blocked).

Response

Returns the updated ticket object.

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

idintegerrequired
Required range: 1 <= x
Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Body

application/json
assigneeIdstring | null
Example: 507f1f77bcf86cd799439013
companyIdstring | null
Example: 507f1f77bcf86cd799439015
contentstring
Example: <p>Updated description.</p>
customFieldsobject
openboolean
Example: false
skipNotificationsbooleandefault:false
Example: false
snoozedUntilstring | null
Example: 2025-01-16T09:00:00.000Z
statusIdstring
Example: 507f1f77bcf86cd799439016
titlestring
Minimum string length: 2
Example: Updated ticket title

Response

application/json

Success

assigneeIdstring | nullrequired

Assigned admin ID

Example: 507f1f77bcf86cd799439013
authorobject | nullrequired

Contact who created the ticket

categoryTypeenum<string>required

Ticket category type

Available options: customer, tracker, back-office
Example: customer
companyIdstring | nullrequired

Associated company ID

Example: 507f1f77bcf86cd799439015
contentstringrequired

Ticket content/description (HTML)

Example: <p>I get a 403 error when logging in.</p>
conversationPartsobject[]

Conversation message history. Only included when fetching a single ticket by ID.

createdAtstringrequired

ISO 8601 creation timestamp

Example: 2025-01-15T10:30:00.000Z
customFieldsobjectrequired

Custom field values keyed by field ID. File-type fields contain a JSON string of { key, name, url } with a signed download URL (1 hour expiry). For allowMultiple file fields, the value is a JSON string of an array of these objects.

idstringrequired

Unique identifier (MongoDB ID)

Example: 507f1f77bcf86cd799439011
integrationsobjectrequired

Third-party integration links

linkedConversationsobject[]required

Linked conversations

objectenum<string>required

Object type identifier

Available options: ticket
Example: ticket
openbooleanrequired

Whether the ticket is open

Example: true
snoozedUntilstring | nullrequired

ISO 8601 timestamp until snoozed (from linked conversation)

Example: 2025-01-16T09:00:00.000Z
statusobjectrequired

Current ticket status

teamAssigneeIdstring | nullrequired

Assigned team ID (from linked conversation)

Example: 507f1f77bcf86cd799439014
ticketCategoryIdstringrequired

Ticket category ID

Example: 507f1f77bcf86cd799439011
ticketNumbernumberrequired

Sequential display ID (e.g. TK-42)

Example: 42
ticketUrlstringrequired

Full URL to view the ticket

Example: https://feedback.example.com/p/cannot-login
titlestringrequired

Ticket title

Example: Cannot login to dashboard
updatedAtstringrequired

ISO 8601 last updated timestamp

Example: 2025-01-15T12:30:00.000Z