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

NameTypeRequiredDescription
organization_idintegerYesYour organization ID.
subjectstringYesTicket subject.
contact_idintegerNoContact who opened the ticket. Their email and name are copied to meta_contact_email, meta_contact_first_name, meta_contact_last_name.
statusstringNoopen (default), pending, waiting_customer, done or closed.
prioritystringNolow, medium (default), high or urgent.
tagsarrayNoTags: [{ "id": 3, "name": "login", "color": "#3B82F6" }].
reference_numberstringNoYour own reference.
assigned_user_idintegerNoHuman owner (notified).
assigned_ai_assistant_idintegerNoAI assistant.
pipeline_id / pipeline_stage_idintegerNoTicket pipeline and stage.
custom_fields_by_keyobjectNoCustom 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

StatusWhen
400 Bad RequestAn unknown field, an invalid status / priority, an invalid custom field value, or a pipeline you cannot access.
500organization_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.