API Reference

Create a ticket

post
https://{domain}.gorgias.com/api/tickets
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
assignee_team

Team assigned to the ticket

assignee_user

User assigned to this ticket

enum

Channel used to initiate the conversation with the customer

When the ticket was closed

When the ticket was created

custom_fields

Custom fields associated with the ticket

customer

Customer associated with the ticket

length ≤ 255

ID of the ticket in a foreign system. This field is not used by Gorgias, feel free to set it as you wish.

Whether the first message of the ticket was sent by your company to a customer, or the opposite

Language primarily used in the ticket. The language is automatically detected on the first messages by Gorgias if not set explicitly. Once the language has been set, it won't be updated according to future messages.

When the last message was sent

When the last customer's message was received

messages
array of objects
required
length between 1 and 500

Messages of the ticket

Messages*
actions

Actions associated with the message

attachments

Attachments associated with the message

HTML version of the body of the message

Text version of the body of the message

enum
required

Channel used to send the message

When the message was created

When the message was deleted

length ≤ 255

ID of the message in a foreign system (Aircall, Zendesk, etc...). This field is not used by Gorgias, feel free to set it as you wish.

When the message failed to be sent. Messages that couldn't be sent can be resend.

boolean
required

Whether the message was sent by your company

headers

Headers of the message

ID of the Integration used to send the message

last_sending_error

Details of the last error encountered when Gorgias attempted to send the message

macros

Macros used to compose the message

mention_ids

List of User IDs to mention along with the internal note.

ID of the message on the service that send the message. It can be the ID of an email, a Messenger message, a Facebook comment, etc...

meta

Metadata associated with the ticket.You can use this field to store structured information (key-value data) about the ticket.

When the message was seen by their recipient

boolean
Defaults to true

Whether the message is public. Only internal notes are private.

receiver

Primary receiver of the message. It can be a user or a customer. Optional when the source type is "internal-note".

sender

Person who sent the message. It can be a user or a customer.

When the message was sent. If ommited, the message will be sent by Gorgias.

source

Information used to route the message. It contains the names and the addresses of the sender and receivers.

HTML version of the body of the message without email signatures and previous replies.

signature stripped from the body of the message

Text version of the body of the message without email signatures and previous replies.

Subject of the message

string
enum
required

How the message has been received or sent from Gorgias

meta

Metadata associated with the ticketYou can use this field to store structured information (key-value data) about the ticket

When the ticket was opened for the first time by a User

string
enum
Defaults to normal

Priority of the ticket

Allowed:

When the ticket will be re-opened automatically

Whether the ticket is considered as spam

string
enum
Defaults to open

The status of the ticket

Allowed:
length ≤ 998

Subject of the ticket

tags

The tags associated with the ticket

When the ticket was moved to the trash

When the ticket was lastly updated

string
enum
required

How the first message of the ticket has been received or sent from Gorgias

Response

Updated 4 months ago

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

Updated 4 months ago