Inbox
Tickets
Create and work support tickets, and configure the inboxes they arrive in.
16 endpoints
- POSTCreate ticket/api/ext/omni_v2/ticketCreates a new support ticket (conversation) and returns the full ticket object including its server-assigned id, inbox, status, priority, and any seeded message.
- GETList tickets/api/ext/omni_v2/ticketReturns a paginated list of support tickets (conversations) for the project tied to your API key, with a meta object holding live counts by assignee bucket and a payload array of ticket objects.
- POSTFilter tickets/api/ext/omni_v2/ticket/filterLists tickets using a structured server-side filter supplied in the request body, returning the same meta/payload shape as the generic list endpoint.
- POSTList tickets by contact/api/ext/omni_v2/ticket/contact/{contact_id}Lists tickets associated with the contact identified by contact_id, with optional server-side filtering in the request body and pagination via the page query parameter.
- GETGet ticket/api/ext/omni_v2/ticket/{id}Fetches a single ticket by its numeric id and returns the full ticket object: lifecycle status, priority, assignee and sender metadata, labels, the latest non-activity message, and an embedded messages array.
- GETList ticket messages/api/ext/omni_v2/ticket/{id}/messagesReturns the message history for a ticket, ordered for display, along with a meta block describing the contact, labels, and seen timestamps.
- POSTAdd a ticket message/api/ext/omni_v2/ticket/{id}/messagesAdds a new message to the ticket identified by path id and returns the created message object (id, content, sender, type, timestamps).
- POSTAdd a ticket message with attachments/api/ext/omni_v2/ticket/{id}/messages_with_attachmentAdds a new message to the ticket identified by path id with one or more file attachments (images, PDFs, etc.), and returns the created message object including its attachments.
- POSTAssign ticket/api/ext/omni_v2/ticket/{id}/assignAssigns the ticket identified by path id to a specific agent/user.
- POSTChange ticket status/api/ext/omni_v2/ticket/{id}/toggle_statusChanges the lifecycle status of the ticket identified by path id.
- POSTChange ticket priority/api/ext/omni_v2/ticket/{id}/toggle_prioritySets (toggles) the priority of the ticket identified by path id.
- POSTChange ticket type/api/ext/omni_v2/ticket/{id}/update_typeUpdates the category (type) of the ticket identified by path id.
- POSTCreate ticket inbox/api/ext/omni_v2/ticket/inboxesCreates a ticket inbox for the project tied to your API key and returns the created inbox object including its server-assigned id.
- GETList ticket inboxes/api/ext/omni_v2/ticket/inboxesLists the ticket inboxes configured for the project tied to your API key.
- PATCHUpdate ticket inbox/api/ext/omni_v2/ticket/inboxesUpdates the ticket inbox configuration for the project tied to your API key and returns the resulting inbox object.
- DELDelete ticket inbox/api/ext/omni_v2/ticket/inboxesDeletes the ticket inbox configuration for the project tied to your API key and returns a boolean indicating success.