TicketsApi

All URIs are relative to https://freshdesk.com/api/v2

Method	HTTP request	Description
addNote	POST /tickets/{id}/notes	Add a note in a Ticket
createTicket	POST /tickets	create a ticket
createTicketUsingOutboundEmail	POST /tickets/outbound_email	Create a ticket using outbound email
deleteAttachment	DELETE /attachments/{id}	Delete an Attachment
deleteTicket	DELETE /tickets/{id}	Delete a ticket
getTicket	GET /tickets/{id}	Get a ticket
listTicketSatisfactionRatings	GET /tickets/{id}/satisfaction_ratings	List all satisfaction ratings of a Ticket
listTicketTimeEntries	GET /tickets/{id}/time_entries	List all time entries of a Ticket
listTickets	GET /tickets	List all tickets
replyTicket	POST /tickets/{id}/reply	Reply to a Ticket
restoreTicket	PUT /tickets/{id}/restore	Restore Ticket
searchTicket	GET /search/tickets	Search Tickets
updateTicket	PUT /tickets/{id}	Update a ticket

addNote

Add a note in a Ticket

Method syntax: Notes addNote(id, notes)

Parameters

Name	Type	Description	Notes
id	Number
notes	Notes

Return type

Notes

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createTicket

create a ticket

Method syntax: PostTicketResponse createTicket(ticket)

Parameters

Name	Type	Description	Notes
ticket	PostTicket	Ticket entity

Return type

PostTicketResponse

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createTicketUsingOutboundEmail

Create a ticket using outbound email

Method syntax: GetTicket createTicketUsingOutboundEmail(requester)

Parameters

Name	Type	Description	Notes
requester	OutBoundEmailRequest

Return type

GetTicket

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteAttachment

Delete an Attachment

Method syntax: deleteAttachment(id)

Parameters

Name	Type	Description	Notes
id	Number

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

deleteTicket

Delete a ticket

Method syntax: deleteTicket(id)

Parameters

Name	Type	Description	Notes
id	Number

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getTicket

Get a ticket

Method syntax: GetTicket getTicket(id, opts)

Parameters

Name	Type	Description	Notes
id	Number
include	String	Comma-separated values	[optional]

Return type

GetTicket

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

listTicketSatisfactionRatings

List all satisfaction ratings of a Ticket

Method syntax: [SatisfactionRating] listTicketSatisfactionRatings(id)

Parameters

Name	Type	Description	Notes
id	Number

Return type

[SatisfactionRating]

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

listTicketTimeEntries

List all time entries of a Ticket

Method syntax: [TicketEntry] listTicketTimeEntries(id, opts)

Parameters

Name	Type	Description	Notes
id	Number
page	Number		[optional]

Return type

[TicketEntry]

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

listTickets

List all tickets

Method syntax: [GetAllTicketResponse] listTickets(opts)

Parameters

Name	Type	Description	Notes
filter	String		[optional]
include	String	Comma-separated values	[optional]
companyId	Number		[optional]
requesterId	Number		[optional]
email	String		[optional]
updatedSince	Date		[optional]
orderBy	String		[optional]
orderType	String		[optional]

Return type

[GetAllTicketResponse]

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

replyTicket

Reply to a Ticket

Method syntax: TicketsReply replyTicket(id, ticketReply)

Parameters

Name	Type	Description	Notes
id	Number
ticketReply	TicketsReply

Return type

TicketsReply

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

restoreTicket

Restore Ticket

Method syntax: restoreTicket(id)

Parameters

Name	Type	Description	Notes
id	Number	Display ID of ticket

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

searchTicket

Search Tickets

Method syntax: TicketSearchResult searchTicket(query)

Parameters

Name	Type	Description	Notes
query	String	Query Hash used for the search

Return type

TicketSearchResult

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

updateTicket

Update a ticket

Method syntax: PutTicketResponse updateTicket(id, ticket)

Parameters

Name	Type	Description	Notes
id	Number
ticket	PutTicketRequest

Return type

PutTicketResponse

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json