Support Tickets
A support ticket is an email thread with a customer in your helpdesk inbox (Gmail or Outlook). Use it to list, create, assign, prioritize and close tickets, move them through ticket pipelines and set their custom fields.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /support-tickets | List tickets |
GET | /support-tickets/:id | Get a ticket |
POST | /support-tickets | Create a ticket |
PATCH | /support-tickets/:id | Update a ticket |
DELETE | /support-tickets/:id | Delete a ticket |
The support ticket object
json
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
organization_id | integer | Organization. Required on create. |
inbox_channel_id | integer | Read-only on create. Helpdesk inbox (email account) of the ticket. Set to the organization's active inbox. |
channel | string | Read-only. gmail or outlook, from the inbox. |
meta_inbox_channel_email | string | null | Read-only. Email address of the inbox. |
contact_id | integer | null | Contact who opened the ticket. |
meta_contact_email | string | null | Contact email, copied from the contact on create. |
meta_contact_first_name / meta_contact_last_name | string | null | Contact name, copied from the contact on create. |
reference_number | string | null | Your own reference for the ticket. |
subject | string | Ticket subject. Required on create. |
status | string | open, pending, waiting_customer, done or closed. Default open. |
priority | string | low, medium, high or urgent. Default medium. |
tags | array | Tags: { "id", "name", "color" }. Default []. |
assigned_user_id | integer | null | Human owner. Changing it notifies the new owner. |
assigned_ai_assistant_id | integer | null | AI assistant answering the ticket. |
thread_id | string | Read-only. Email thread ID in the mailbox (created-<timestamp> for tickets created through the API). |
last_message_at | string (date-time) | Read-only. Time of the last message. |
last_message_received / last_message_sent / last_message_system | string (date-time) | Read-only. Time of the last incoming, outgoing and system message. |
unread_count | integer | Unread incoming messages. Default 0. |
is_unread | boolean | Marked unread in the inbox. Default false. |
handoff_reason | string | null | Why the AI assistant handed the ticket to a human. |
next_follow_up_rule_id | string | null | Read-only. AI follow-up rule scheduled next. |
next_follow_up_date_time | string | null | When the next AI follow-up is scheduled. Setting it schedules the follow-up. |
follow_up_count | integer | Read-only. AI follow-ups sent. Default 0. |
pipeline_id | integer | null | Ticket pipeline (type ticket). |
pipeline_stage_id | integer | null | Stage inside pipeline_id. |
custom_fields_by_key | object | Custom field values by field key. Write custom fields here; values are validated against the field type. |
custom_fields_by_name | object | Read-only. Same values keyed by field name. |
conversation_summary | string | null | Read-only. AI summary of older messages. |
conversation_summary_updated_at | string (date-time) | null | Read-only. |
created_at | string (date-time) | Read-only. |
updated_at | string (date-time) | Read-only. |
deleted_at | string (date-time) | null | Read-only. Set when the ticket is deleted. |
Reads are limited to your API key's organization. Member roles with limited ticket permissions only see and edit what their role allows.
Related
- Contacts
- Pipelines and Pipeline stages (type
ticket) - Upload URLs (type
support-ticket-file) - Errors
Report an issue with this documentation
Please log in to report issues with our documentation.