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
object

Team assigned to the ticket

assignee_user
object

User assigned to this ticket

legacy channel slug | string

Channel used to initiate the conversation with the customer

date-time

When the ticket was closed

date-time

When the ticket was created

custom_fields
array of objects

Custom fields associated with the ticket

custom fields
customer
object

Customer associated with the ticket

string
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.

boolean

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

string

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.

date-time

When the last message was sent

date-time

When the last customer's message was received

messages
array of objects
required
length between 1 and 500

Messages of the ticket

messages*
actions
array

Actions associated with the message

actions
attachments
array of objects

Attachments associated with the message

attachments
string

HTML version of the body of the message

string

Text version of the body of the message

legacy channel slug | string
required

Channel used to send the message

date-time

When the message was created

date-time

When the message was deleted

string
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.

date-time

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

boolean
required

Whether the message was sent by your company

headers
object

Headers of the message

integer

ID of the Integration used to send the message

last_sending_error
object

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

macros
array of objects

Macros used to compose the message

macros
string

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

meta
object

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

date-time

When the message was seen by its recipient

boolean
Defaults to true

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

date-time

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

source
object

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

string

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

string

Signature stripped from the body of the message

string

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

string

Subject of the message

string
enum
Defaults to api

How the message has been received or sent from Gorgias

mention_ids
array of integers

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

mention ids
receiver
object

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

sender
object

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

meta
object

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

date-time

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

string
enum
Defaults to normal

Priority of the ticket

Allowed:
date-time

When the ticket will be re-opened automatically

boolean
Defaults to false

Whether the ticket is considered as spam

integer

ID of the ticket that this ticket was split from.

string
enum
Defaults to open

The status of the ticket

Allowed:
string
length ≤ 998

Subject of the ticket

tags
array of objects

The tags associated with the ticket

tags
date-time

When the ticket was moved to the trash

date-time

When the ticket was lastly updated

string
enum
Defaults to api

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

boolean
Defaults to false

Whether the ticket was created by a historical import. When set to true, the ticket and all its messages are flagged as imported.

Response

Updated 16 days 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 16 days ago