Add Ticket Comment

Post a comment on an existing support ticket.

POST
/api/v1/tickets/comment/add

Description

Adds a message to the ticket thread.

Request

Headers

HeaderValueRequired
AuthorizationBearer <access_token>Yes
Content-Typeapplication/jsonYes

Body Parameters

ParameterTypeRequiredDescription
ticketIdstringYesTicket ID or ticket number.
messagestringYesComment text (non-empty).
senderAppstringNoresolve-now or resolve-it (default resolve-it).

Example Request Body

{
  "ticketId": "674a1b2c3d4e5f6789012345",
  "message": "Please expedite the return label.",
  "senderApp": "resolve-it"
}

Response

FieldTypeDescription
successbooleanWhether the request succeeded.
messagestringHuman-readable confirmation.
dataobjectCreated comment details.
data.comment_idstringComment ID.
data.sender_appstringresolve-now or resolve-it.
data.sender_idstringOpaque sender user ID.
data.sender_namestringDisplay name of the comment author.
data.messagestringComment text.
data.created_atstringComment timestamp (ISO 8601).
data.ticket_idstringParent ticket ID.
data.ticket_numberstringParent ticket number.

Related Endpoints

Did this page help you?