Create a support ticket
Create a support ticket in your helpdesk. The organization needs an active helpdesk inbox (Gmail or Outlook): the ticket is attached to it automatically.
Endpoint
POST/support-tickets
Body
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | integer | Yes | Your organization ID. |
subject | string | Yes | Ticket subject. |
contact_id | integer | No | Contact who opened the ticket. Their email and name are copied to meta_contact_email, meta_contact_first_name, meta_contact_last_name. |
status | string | No | open (default), pending, waiting_customer, done or closed. |
priority | string | No | low, medium (default), high or urgent. |
tags | array | No | Tags: [{ "id": 3, "name": "login", "color": "#3B82F6" }]. |
reference_number | string | No | Your own reference. |
assigned_user_id | integer | No | Human owner (notified). |
assigned_ai_assistant_id | integer | No | AI assistant. |
pipeline_id / pipeline_stage_id | integer | No | Ticket pipeline and stage. |
custom_fields_by_key | object | No | Custom field values by key. |
inbox_channel_id, channel, meta_inbox_channel_email, thread_id and last_message_at are set by the server from the organization's active inbox; values you send are replaced.
Request
Response
The created support ticket:
json
Creating a ticket does not send an email; reply from the helpdesk inbox in the app.
Errors
| Status | When |
|---|---|
400 Bad Request | An unknown field, an invalid status / priority, an invalid custom field value, or a pipeline you cannot access. |
500 | organization_id missing, subject missing, or the organization has no active helpdesk inbox. |
Report an issue with this documentation
Please log in to report issues with our documentation.