REST - TicketNote

Table of contents
1 GET /Tickets/TicketNote/ListAll/$ticketid$ 1.1 Arguments 1.2 Response 2 GET /Tickets/TicketNote/$ticketid$/$id$ 2.1 Arguments 2.2 Response 3 POST /Tickets/TicketNote 3.1 Arguments (POST variables) 3.2 Response 4 DELETE /Tickets/TicketNote/$ticketid$/$id$ 4.1 Arguments 4.2 Response

GET /Tickets/TicketNote/ListAll/$ticketid$

API method modified in version 4.01.220
This API method was modified in Kayako version 4.01.220 (and above). You should update your helpdesk before relying on this method.

Retrieve a list of a ticket's notes.

Arguments

Red = required

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

Response

An 'HTTP 200 OK' with the following XML payload:

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

API method modified in version 4.01.220
This API method was modified in Kayako version 4.01.220 (and above). You should update your helpdesk before relying on this method.

Retrieve the note identified by $id$ that belongs to a ticket identified by $ticketid$ .

Arguments

Red = required

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

Response

An 'HTTP 200 OK' with the following XML payload:

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 [note colors]

Response

An 'HTTP 200 OK' with the following XML payload:

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.

Response

If an 'HTTP 200 OK' is returned, the deletion was successful. If a different HTTP status code is returned, the deletion failed. Consult the status code list for a list of error statuses and their respective meanings.