API Reference

Update a message

put
https://{domain}.gorgias.com/api/tickets//messages/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The ID of the ticket associated with the message.

integer
required

The ID of the message to update.

Query Params
string
enum

Policy applied on external actions associated with the message if they failed. Three actions are possible:

  • force: bypass the failed action and try to execute the remaining one and to send the message
  • retry: retry the failed action
  • cancel: delete the TicketMessage
Allowed:
Body Params
attachments
array of objects

A list of files attached to the message.

attachments
string | null

The full HTML version of the body of the message, if any.

string | null

The full text version of the body of the message, if any.

string
enum
required

The channel used to send the message.

string | null

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 | null

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 to a customer, or the opposite.

string | null

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

receiver
object

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

sender
object

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

date-time | null

When the message was sent. If ommited, 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 | null

The subject of the message.

string
enum
required

How the message 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