Overview

This article provides details about the REST - TicketNote API call that Kayako Classic uses, including its field types, arguments, and responses. 

• GET /Tickets/TicketNote/ListAll/$ticketid$
  • Arguments
  • Response
• GET /Tickets/TicketNote/$ticketid$/$id$
  • Arguments
  • Response
• POST /Tickets/TicketNote
  • Arguments (POST variables)
  • Response
• DELETE /Tickets/TicketNote/$ticketid$/$id$
  • Arguments

 

Information

GET /Tickets/TicketNote/ListAll/$ticketid$

Retrieve a list of a ticket's notes.
Note: API modified in version > v4.01.220.

Arguments

Red = required

Name	Description
$ticketid$	The unique numeric identifier of the ticket

Response

<notes>
   <note type="ticket" id="1" ticketid="12345" notecolor="1"creatorstaffid="1" forstaffid="0" creatorstaffname="Varun Shoor"creationdate="1297842435">
     <![CDATA[This is a test Usernote]]]]>
     <![CDATA[>
   </note>
   <note type="ticket" id="2" ticketid="12346" notecolor="3"creatorstaffid="5" forstaffid="0" creatorstaffname="Jamie Edwards"creationdate="1297842447">
     <![CDATA[This is a test User Organizationnote]]]]>
     <![CDATA[>
   </note>
</notes>

 

GET /Tickets/TicketNote/$ticketid$/$id$

Arguments

Red = required

Name	Description
$ticketid$	The unique numeric identifier of the ticket
$id$	The unique numeric identifier of the ticket note

Response

<notes>
  <note type="ticket" id="1" ticketid="12345" notecolor="1"creatorstaffid="1" forstaffid="0" creatorstaffname="Varun Shoor"creationdate="1297842447">
    <![CDATA[This is a test User Organizationnote]]]]>
    <![CDATA[>
  </note>
</notes>

 

POST /Tickets/TicketNote

Add a new note to a ticket.

Arguments (POST variables)

Red = required, Blue = Either of the value

Name	Description
ticketid	The unique numeric identifier of the ticket
contents	The ticket note contents
staffid	The Staff ID, if the ticket is to be created as a staff.
fullname	The Fullname, if the ticket is to be created without providing a staff user. Example: System messages, Alerts, etc.
forstaffid	The Staff ID, this value can be provided if you wish to restrict the note visibility to a specific staff
notecolor	The Note Color, for more information see

Response

<notes>
  <note type="ticket" notecolor="1" creatorstaffid="1" forstaffid="0"creatorstaffname="Varun Shoor" creationdate="1297842447">
   <![CDATA[Thisis a test User Organization note]]]]>
   <![CDATA[>
  </note>
</notes>

 

DELETE /Tickets/TicketNote/$ticketid$/$id$

Delete the note identified by $id$ linked to the $ticketid$.

Arguments

Red = required

Name	Description
$ticketid$	The unique numeric identifier of the ticket
$id$	The unique numeric identifier of the ticket note