Create

This endpoint creates a new ticket with participant/s and fields. After creation, you can send messages on behalf of users. You don't need to include the ticket's owner as participant. Lean more about how to create a ticket in this guide.

Body Params
string
length ≤ 120

Free text field for ticket subject.

string
length ≤ 120

Dynamic field.

string
length ≤ 120

Dynamic field.

string
length ≤ 120

Dynamic field.

string
length ≤ 120

Dynamic field.

string
length ≤ 120

Dynamic field.

string
length ≤ 120

Dynamic field.

string
length ≤ 120

Dynamic field.

string
length ≤ 120

Dynamic field.

string
length ≤ 120

Dynamic field.

string
enum
required
Defaults to en-US

"Restricted code list to note ticket/participant's language/culture. Can customize user's GUI.

  • en-US; English
  • he-IL; Hebrew
  • pt-PT; Portuguese
  • es-ES; Spanish"
Allowed:
participants
array of objects
required
participants*
tags
array of strings

Ticket's tags.

tags
string

The unique argument parameter can help you to keep the CRM's tickets in sync. We'll return this parameter on every event or endpoint.

string
enum
Defaults to Open

The ticket's state.

Allowed:
date-time

ISO-8601-formatted datetime of when this ticket was opened; as UTC. Defaults to Now (sys-time).

date-time

ISO-8601-formatted datetime of when this ticket was closed; as UTC. Required when the ticket state is "Closed".

boolean
Defaults to true

If set to true, the ticket will be assigned to the next available user. Otherwise, the ticket will be assigned to the token's user.

boolean
Defaults to true

Switch to control whether to send a greeting message to the participants.

boolean
Defaults to true

Enables the webhook callback of a new ticket.

boolean
Defaults to false

If set to True, the conversation is marked as read and no notification will be shown.

details
object

Additional details about this ticket. You can set the details object either when creating a ticket or when updating existing ticket.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json