Skip to main content
Server path: /freshdesk-tickets | Type: Application | PCID required: Yes

Tools


freshdesk_tickets_add_note_to_ticket

Add a note to a ticket Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the ticket to add a note to
bodystringYesHTML content of the note
notify_emailsstring[]NoArray of agent email addresses to notify about this note
privatebooleanNoWhether the note is private (only visible to agents). Default: true

freshdesk_tickets_create_ticket

Create a ticket Parameters:
ParameterTypeRequiredDefaultDescription
cc_emailsstring[]NoEmail addresses to CC
company_idintegerNoID of the company to associate
custom_fieldsobjectNoKey-value pairs for custom fields
descriptionstringYesHTML content of the ticket description
due_bystringNoDue date for the ticket
emailstringNoEmail address of the requester. Required if requester_id is not provided.
facebook_idstringNoFacebook ID of the requester
fr_due_bystringNoFirst response due date
group_idintegerNoID of the group to assign the ticket to
phonestringNoPhone number of the requester
priorityintegerNoPriority: 1=Low, 2=Medium, 3=High, 4=Urgent
product_idintegerNoID of the product to associate
requester_idintegerNoID of the requester contact. Required if email is not provided.
responder_idintegerNoID of the agent to assign the ticket to
sourceintegerNoSource: 1=Email, 2=Portal, 3=Phone, 7=Chat, 9=Feedback Widget, 10=Outbound Email
statusintegerNoStatus: 2=Open, 3=Pending, 4=Resolved, 5=Closed
subjectstringYesSubject of the ticket
tagsstring[]NoTags to associate with the ticket
twitter_idstringNoTwitter handle of the requester
typestringNoTicket type (e.g., Question, Incident, Problem, Feature Request)

freshdesk_tickets_delete_conversation

Delete a conversation Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the conversation to delete

freshdesk_tickets_delete_ticket

Delete a ticket Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the ticket to delete

freshdesk_tickets_get_ticket

Get a ticket Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the ticket
includestringNoInclude additional information. Comma-separated: conversations, requester, company, stats, sla_policy

freshdesk_tickets_list_ticket_conversations

List conversations for a ticket Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the ticket
pageintegerNoPage number for pagination
per_pageintegerNoNumber of results per page (max 100)

freshdesk_tickets_list_ticket_fields

List all ticket fields

freshdesk_tickets_list_tickets

List all tickets Parameters:
ParameterTypeRequiredDefaultDescription
filterstringNoPre-defined filter to use. One of: new_and_my_open, watching, spam, deleted
requester_idintegerNoFilter tickets by requester ID
emailstringNoFilter tickets by requester email
company_idintegerNoFilter tickets by company ID
updated_sincestringNoReturn tickets updated since this date-time (ISO 8601 format)
order_bystringNoField to order results by. One of: created_at, due_by, updated_at, status
order_typestringNoSort order: asc or desc
includestringNoInclude additional information. Comma-separated: requester, stats, company, description
pageintegerNoPage number for pagination (starts at 1)
per_pageintegerNoNumber of results per page (max 100)

freshdesk_tickets_reply_to_ticket

Reply to a ticket Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the ticket to reply to
bcc_emailsstring[]NoArray of email addresses to BCC
bodystringYesHTML content of the reply
cc_emailsstring[]NoArray of email addresses to CC
from_emailstringNoEmail address from which the reply is sent. By default the global support email is used.

freshdesk_tickets_restore_ticket

Restore a deleted ticket Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the ticket to restore

freshdesk_tickets_search_tickets

Search tickets Parameters:
ParameterTypeRequiredDefaultDescription
querystringYesSearch query using Freshdesk query language. The value MUST be enclosed in double quotes, e.g. “status:2 AND priority:3”. Without the surrounding quotes, the API will return an error.
pageintegerNoPage number for pagination (starts at 1, max 10 pages)

freshdesk_tickets_update_conversation

Update a conversation Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the conversation to update
attachmentsstring[]NoUpdated attachments for the conversation
bodystringNoUpdated HTML content of the conversation

freshdesk_tickets_update_ticket

Update a ticket Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the ticket to update
cc_emailsstring[]NoCC email addresses
company_idintegerNoCompany ID
custom_fieldsobjectNoCustom field key-value pairs
descriptionstringNoHTML content of the ticket description
due_bystringNoDue date
emailstringNoRequester email
fr_due_bystringNoFirst response due date
group_idintegerNoID of the group to assign
phonestringNoRequester phone
priorityintegerNoPriority: 1=Low, 2=Medium, 3=High, 4=Urgent
product_idintegerNoProduct ID
responder_idintegerNoID of the agent to assign
sourceintegerNoSource: 1=Email, 2=Portal, 3=Phone, 7=Chat, 9=Feedback Widget, 10=Outbound Email
statusintegerNoStatus: 2=Open, 3=Pending, 4=Resolved, 5=Closed
subjectstringNoSubject of the ticket
tagsstring[]NoTags for the ticket
typestringNoTicket type