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

MethodPathDescription
GET/support-ticketsList tickets
GET/support-tickets/:idGet a ticket
POST/support-ticketsCreate a ticket
PATCH/support-tickets/:idUpdate a ticket
DELETE/support-tickets/:idDelete a ticket

The support ticket object

json

Fields

FieldTypeDescription
idintegerRead-only. Unique ID.
organization_idintegerOrganization. Required on create.
inbox_channel_idintegerRead-only on create. Helpdesk inbox (email account) of the ticket. Set to the organization's active inbox.
channelstringRead-only. gmail or outlook, from the inbox.
meta_inbox_channel_emailstring | nullRead-only. Email address of the inbox.
contact_idinteger | nullContact who opened the ticket.
meta_contact_emailstring | nullContact email, copied from the contact on create.
meta_contact_first_name / meta_contact_last_namestring | nullContact name, copied from the contact on create.
reference_numberstring | nullYour own reference for the ticket.
subjectstringTicket subject. Required on create.
statusstringopen, pending, waiting_customer, done or closed. Default open.
prioritystringlow, medium, high or urgent. Default medium.
tagsarrayTags: { "id", "name", "color" }. Default [].
assigned_user_idinteger | nullHuman owner. Changing it notifies the new owner.
assigned_ai_assistant_idinteger | nullAI assistant answering the ticket.
thread_idstringRead-only. Email thread ID in the mailbox (created-<timestamp> for tickets created through the API).
last_message_atstring (date-time)Read-only. Time of the last message.
last_message_received / last_message_sent / last_message_systemstring (date-time)Read-only. Time of the last incoming, outgoing and system message.
unread_countintegerUnread incoming messages. Default 0.
is_unreadbooleanMarked unread in the inbox. Default false.
handoff_reasonstring | nullWhy the AI assistant handed the ticket to a human.
next_follow_up_rule_idstring | nullRead-only. AI follow-up rule scheduled next.
next_follow_up_date_timestring | nullWhen the next AI follow-up is scheduled. Setting it schedules the follow-up.
follow_up_countintegerRead-only. AI follow-ups sent. Default 0.
pipeline_idinteger | nullTicket pipeline (type ticket).
pipeline_stage_idinteger | nullStage inside pipeline_id.
custom_fields_by_keyobjectCustom field values by field key. Write custom fields here; values are validated against the field type.
custom_fields_by_nameobjectRead-only. Same values keyed by field name.
conversation_summarystring | nullRead-only. AI summary of older messages.
conversation_summary_updated_atstring (date-time) | nullRead-only.
created_atstring (date-time)Read-only.
updated_atstring (date-time)Read-only.
deleted_atstring (date-time) | nullRead-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

Report an issue with this documentation

Please log in to report issues with our documentation.