Freshdesk

App · 24 actions

Run customer support from workflows with Freshdesk: raise, update, find, merge and reply to tickets, add notes, manage contacts and companies, and search your knowledge base.

Actions

ActionWhat it does
Add noteAdd a note to a ticket: private for your team by default, or public for the requester to see.
Create companyAdd a company, so its contacts and their tickets are grouped together.
Create contactAdd a customer as a contact.
Create ticketRaise a ticket for a customer, by their email address or contact.
Delete companyDelete a company for good.
Delete contactDelete a contact.
Delete ticketMove a ticket to Freshdesk's Trash, where it can be restored.
Find contactsFind contacts by email address, phone, company or state, or those changed since a time.
Find ticketsFind tickets by status, open or resolved, priority, group, agent, type, tag, creation date or the day they last changed.
Get companyGet one company's details.
Get contactGet one contact's details.
Get my agent profileGet the agent whose API key the connection uses.
Get ticketGet one ticket with its description and the requester's name and email.
List agentsList your support agents.
List companiesList companies, or those changed since a time.
List groupsList the groups tickets are routed to.
List replies and notesList a ticket's replies and notes, oldest first.
List ticketsList tickets, newest first, for a requester, a company or a view, or those changed since a time.
Merge ticketsMerge tickets about the same issue into one.
Reply to ticketEmail a reply to the ticket's requester, from your support address.
Search knowledge baseFind knowledge base articles that mention a word or phrase.
Update companyChange a company's details.
Update contactChange a contact's details.
Update ticketChange a ticket's status, priority, assignment, type, tags or other fields.

Add note

Add a note to a ticket: private for your team by default, or public for the requester to see.

Inputs

Ticketticket_idtextRequired
The ticket's number, from a trigger, 'Create ticket' or a list step. Its page address works too.
NotebodytextRequired
The note. Line breaks are kept.
Privateprivatetrue/false
Only agents see a private note. On by default.Default: true.
Notifynotify_emailslist
Agents' email addresses to tell about the note.

Outputs

conversationobject
The reply or note
Example output
{
  "conversation": {
    "body": "<div>Hi tom, Still Angry</div>",
    "body_text": "Hi tom, Still Angry",
    "cc_emails": [],
    "created_at": "2015-08-24T13:49:37Z",
    "from_email": "",
    "id": "5",
    "incoming": false,
    "kind": "note",
    "private": false,
    "ticket_id": "3",
    "to_emails": [],
    "updated_at": "2015-08-24T13:49:37Z",
    "user_id": "1"
  }
}

Create company

Add a company, so its contacts and their tickets are grouped together.

Inputs

NamenametextRequired
The company's name. It must be unique.
Email domainsdomainslist
Domains such as acme.com. Contacts with an email address there join the company.
Descriptiondescriptiontext
What the company does.
Notenotetext
A note for your team.
Health scorehealth_scoretext
One of your account's health scores, such as Happy or At risk.
Account tieraccount_tiertext
One of your account's tiers, such as Basic, Premium or Enterprise.
Industryindustrytext
One of your account's industries, such as Retail.
Renewal daterenewal_datedate
When their contract renews.

Outputs

companyobject
The company
Example output
{
  "company": {
    "account_tier": "Premium",
    "created_at": "2014-01-08T09:08:53+05:30",
    "description": "Spaceship Manufacturing Company",
    "domains": [
      "supernova",
      "nova"
    ],
    "health_score": "Happy",
    "id": "8",
    "industry": "",
    "name": "SuperNova",
    "note": "",
    "renewal_date": "2020-12-31",
    "updated_at": "2014-01-08T09:08:53+05:30"
  }
}

Create contact

Add a customer as a contact. Give an email address, a phone number or an external ID with the name.

Inputs

NamenametextRequired
Their full name.
Emailemailtext
Their main email address.
Phonephonetext
Phone number.
Mobilemobiletext
Mobile number.
Companycompany_idtext
The company they work for.
Job titlejob_titletext
Job title.
Addressaddresstext
Postal address.
Aboutdescriptiontext
A short description of them.
External IDunique_external_idtext
Your own id for them, such as their id in your CRM.
Tagstagslist
Tags to put on the contact.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "address": "",
    "company_id": "23",
    "created_at": "2015-08-28T09:08:16Z",
    "deleted": false,
    "description": "",
    "email": "superman@freshdesk.com",
    "id": "432",
    "job_title": "",
    "language": "en",
    "mobile": "",
    "name": "Super Man",
    "other_emails": [
      "lex@freshdesk.com",
      "louis@freshdesk.com"
    ],
    "phone": "",
    "tags": [],
    "time_zone": "Chennai",
    "unique_external_id": "",
    "updated_at": "2015-08-28T09:08:16Z",
    "verified": false
  }
}

Create ticket

Raise a ticket for a customer, by their email address or contact.

Inputs

SubjectsubjecttextRequired
The ticket's subject line.
DescriptiondescriptiontextRequired
What the ticket is about. Line breaks are kept.
Requester emailrequester_emailtext
Who the ticket is for. A new email address becomes a new contact. Fill in this or 'Requester contact'.
Requester contactrequester_idtext
Or the id of an existing contact, from 'Create contact' or 'Find contacts'.
Requester namerequester_nametext
The requester's name, used when a new contact is made.
Statusstatustext
Defaults to Open.
Priorityprioritytext
Defaults to Low.One of: 1 (Low), 2 (Medium), 3 (High), 4 (Urgent). Default: 1.
Channelsourcetext
Where the request came from. Defaults to Portal.One of: 1 (Email), 2 (Portal), 3 (Phone), 7 (Chat), 9 (Feedback widget). Default: 2.
Typeticket_typetext
The kind of request, such as Question or Incident.
Groupgroup_idtext
The group to route it to.
Agentresponder_idtext
The agent to assign it to.
Companycompany_idtext
The requester's company, if they belong to several.
Tagstagslist
Tags to put on the ticket.
CCcc_emailslist
Email addresses to copy on the ticket's emails.
Due bydue_bydate and time
When the ticket must be resolved. Leave empty to follow your SLA.
First response due byfr_due_bydate and time
When the first reply is due. Must be before 'Due by'. Leave empty to follow your SLA.
Custom fieldscustom_fieldsobject
Values for your own ticket fields. Fields left blank are not changed.

Outputs

ticketobject
The ticket
Example output
{
  "ticket": {
    "cc_emails": [
      "ram@freshdesk.com",
      "diana@freshdesk.com"
    ],
    "company_id": "1",
    "created_at": "2015-07-09T13:08:06Z",
    "custom_fields": {},
    "description": "<div>Some details on the issue ..</div>",
    "description_text": "Some details on the issue ...",
    "due_by": "2015-07-14T13:08:06Z",
    "fr_due_by": "2015-07-10T13:08:06Z",
    "group_id": "",
    "id": "1",
    "is_escalated": false,
    "priority": 1,
    "priority_name": "Low",
    "requester_email": "",
    "requester_id": "129",
    "requester_name": "",
    "responder_id": "",
    "source": 2,
    "source_name": "Portal",
    "spam": false,
    "status": 2,
    "status_name": "Open",
    "subject": "Support needed..",
    "tags": [],
    "type": "Question",
    "updated_at": "2015-07-23T04:41:12Z",
    "url": "https://acme.freshdesk.com/a/tickets/1"
  }
}

Delete company

Delete a company for good. Its contacts stay, no longer linked to it.

Inputs

Companycompany_idtextRequired
Pick a company, or give its id from an earlier step.

Outputs

company_idtext
The company deleted
deletedtrue/false
Always true
Example output
{
  "company_id": "8",
  "deleted": true
}

Delete contact

Delete a contact. Freshdesk keeps it among deleted contacts, where it can be restored.

Inputs

Contactcontact_idtextRequired
The contact's id, from 'Find contacts', 'Create contact' or a trigger.

Outputs

contact_idtext
The contact deleted
deletedtrue/false
Always true
Example output
{
  "contact_id": "432",
  "deleted": true
}

Delete ticket

Move a ticket to Freshdesk's Trash, where it can be restored.

Inputs

Ticketticket_idtextRequired
The ticket's number, from a trigger, 'Create ticket' or a list step. Its page address works too.

Outputs

deletedtrue/false
Always true
ticket_idtext
The ticket moved to Trash
Example output
{
  "deleted": true,
  "ticket_id": "20"
}

Find contacts

Find contacts by email address, phone, company or state, or those changed since a time.

Inputs

Emailemailtext
Only the contact with this email address.
Phonephonetext
Only contacts with this phone number.
Mobilemobiletext
Only contacts with this mobile number.
Companycompany_idtext
Only contacts of this company.
Statestatetext
Only verified, unverified, blocked or deleted contacts. Leave empty for all but blocked and deleted ones.One of: verified, unverified, blocked, deleted.
Updated sinceupdated_sincedate and time
Only those created or changed at or after this time.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 30.From 1 to 100.
Pagepagenumber
Which page to get. Use 'next_page' from the step before.At least 1.

Outputs

contactslist
The contacts
countnumber
How many are returned
has_moretrue/false
Whether there is another page
next_pagenumber
The next page's number, 0 when there is none
Example output
{
  "contacts": [
    {
      "address": "",
      "company_id": "23",
      "created_at": "2015-08-28T09:08:16Z",
      "deleted": false,
      "description": "",
      "email": "superman@freshdesk.com",
      "id": "432",
      "job_title": "",
      "language": "en",
      "mobile": "",
      "name": "Super Man",
      "other_emails": [
        "lex@freshdesk.com",
        "louis@freshdesk.com"
      ],
      "phone": "",
      "tags": [],
      "time_zone": "Chennai",
      "unique_external_id": "",
      "updated_at": "2015-08-28T09:08:16Z",
      "verified": false
    }
  ],
  "count": 1,
  "has_more": false,
  "next_page": 0
}

Find tickets

Find tickets by status, open or resolved, priority, group, agent, type, tag, creation date or the day they last changed. Each ticket says how many days it has been open. New changes take a few minutes to show.

Inputs

Statusstatustext
Only tickets with this status.
Priorityprioritytext
Only tickets with this priority.One of: 1 (Low), 2 (Medium), 3 (High), 4 (Urgent).
Groupgroup_idtext
Only tickets in this group.
Agentresponder_idtext
Only tickets assigned to this agent.
Typeticket_typetext
Only tickets of this type.
Tagtagtext
Only tickets with this tag.
Created fromcreated_fromdate
Only tickets created on or after this day.
Created tocreated_todate
Only tickets created on or before this day.
Advanced filterquerytext
Freshdesk's own filter language, for anything else, such as cf_region:'EMEA' OR priority:4. It is combined with the other filters filled in here: a ticket has to match all of them and this too.
Pagepagenumber
Which page of 30 to get, 1 to 10. Use 'next_page' from the step before.From 1 to 10.
Open or resolvedstatus_grouptext
Beta. Only open tickets (Open or Pending) or only resolved ones (Resolved or Closed), so the workflow needs no advanced filter with Freshdesk's status numbers.One of: open (Open or Pending), resolved (Resolved or Closed).
Updated fromupdated_fromdate
Beta. Only tickets last changed on or after this day, such as the start of the week, so the workflow needs no advanced filter on updated_at.

Outputs

countnumber
How many are returned
has_moretrue/false
Whether there is another page
next_pagenumber
The next page's number, 0 when there is none
ticketslist
The matching tickets
totalnumber
How many match in all
Example output
{
  "count": 1,
  "has_more": false,
  "next_page": 0,
  "tickets": [
    {
      "cc_emails": [
        "clark.kent@kryptonspace.com"
      ],
      "company_id": "2",
      "created_at": "2016-02-20T09:16:58Z",
      "created_display": "Feb 20, 2016",
      "custom_fields": {
        "locked": true,
        "sector_no": 7
      },
      "days_open": 12,
      "description": "<div>Sample description</div>",
      "description_text": "",
      "due_by": "2016-02-23T16:00:00Z",
      "fr_due_by": "2016-02-22T17:00:00Z",
      "group_id": "156",
      "id": "47",
      "is_escalated": true,
      "priority": 3,
      "priority_name": "High",
      "requester_email": "",
      "requester_id": "6007738334",
      "requester_name": "",
      "responder_id": "6001263404",
      "source": 2,
      "source_name": "Portal",
      "spam": false,
      "status": 2,
      "status_name": "Open",
      "subject": "Sample Title",
      "tags": [],
      "type": "",
      "updated_at": "2016-02-23T16:14:57Z",
      "url": "https://acme.freshdesk.com/a/tickets/47"
    }
  ],
  "total": 1
}

Get company

Get one company's details.

Inputs

Companycompany_idtextRequired
Pick a company, or give its id from an earlier step.

Outputs

companyobject
The company
Example output
{
  "company": {
    "account_tier": "Premium",
    "created_at": "2014-01-08T09:08:53+05:30",
    "description": "Spaceship Manufacturing Company",
    "domains": [
      "supernova",
      "nova"
    ],
    "health_score": "Happy",
    "id": "8",
    "industry": "",
    "name": "SuperNova",
    "note": "",
    "renewal_date": "2020-12-31",
    "updated_at": "2014-01-08T09:08:53+05:30"
  }
}

Get contact

Get one contact's details.

Inputs

Contactcontact_idtextRequired
The contact's id, from 'Find contacts', 'Create contact' or a trigger.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "address": "",
    "company_id": "23",
    "created_at": "2015-08-28T09:08:16Z",
    "deleted": false,
    "description": "",
    "email": "superman@freshdesk.com",
    "id": "432",
    "job_title": "",
    "language": "en",
    "mobile": "",
    "name": "Super Man",
    "other_emails": [
      "lex@freshdesk.com",
      "louis@freshdesk.com"
    ],
    "phone": "",
    "tags": [],
    "time_zone": "Chennai",
    "unique_external_id": "",
    "updated_at": "2015-08-28T09:08:16Z",
    "verified": false
  }
}

Get my agent profile

Get the agent whose API key the connection uses.

Inputs

None.

Outputs

agentobject
The agent
Example output
{
  "agent": {
    "available": true,
    "created_at": "2015-08-28T11:47:58Z",
    "email": "superman@freshdesk.com",
    "group_ids": [],
    "id": "432",
    "job_title": "Journalist",
    "mobile": "",
    "name": "Clark Kent",
    "occasional": false,
    "phone": "",
    "time_zone": "Chennai",
    "type": "support_agent"
  }
}

Get ticket

Get one ticket with its description and the requester's name and email.

Inputs

Ticketticket_idtextRequired
The ticket's number, from a trigger, 'Create ticket' or a list step. Its page address works too.

Outputs

ticketobject
The ticket
Example output
{
  "ticket": {
    "cc_emails": [
      "user@cc.com"
    ],
    "company_id": "1",
    "created_at": "2015-08-24T11:56:51Z",
    "custom_fields": {
      "category": "Primary"
    },
    "description": "<div>Not given.</div>",
    "description_text": "Not given.",
    "due_by": "2015-08-27T11:30:00Z",
    "fr_due_by": "2015-08-25T11:30:00Z",
    "group_id": "",
    "id": "20",
    "is_escalated": false,
    "priority": 1,
    "priority_name": "Low",
    "requester_email": "test@test.com",
    "requester_id": "1",
    "requester_name": "Rachel",
    "responder_id": "",
    "source": 2,
    "source_name": "Portal",
    "spam": false,
    "status": 2,
    "status_name": "Open",
    "subject": "",
    "tags": [],
    "type": "",
    "updated_at": "2015-08-24T11:59:05Z",
    "url": "https://acme.freshdesk.com/a/tickets/20"
  }
}

List agents

List your support agents. Needs an admin's API key.

Inputs

Emailemailtext
Only the agent with this email address.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 30.From 1 to 100.
Pagepagenumber
Which page to get. Use 'next_page' from the step before.At least 1.

Outputs

agentslist
The agents
countnumber
How many are returned
has_moretrue/false
Whether there is another page
next_pagenumber
The next page's number, 0 when there is none
Example output
{
  "agents": [
    {
      "available": true,
      "created_at": "2015-08-28T11:47:58Z",
      "email": "superman@freshdesk.com",
      "group_ids": [],
      "id": "432",
      "job_title": "Journalist",
      "mobile": "",
      "name": "Clark Kent",
      "occasional": false,
      "phone": "",
      "time_zone": "Chennai",
      "type": "support_agent"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_page": 0
}

List companies

List companies, or those changed since a time.

Inputs

Updated sinceupdated_sincedate and time
Only those created or changed at or after this time.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 30.From 1 to 100.
Pagepagenumber
Which page to get. Use 'next_page' from the step before.At least 1.

Outputs

companieslist
The companies
countnumber
How many are returned
has_moretrue/false
Whether there is another page
next_pagenumber
The next page's number, 0 when there is none
Example output
{
  "companies": [
    {
      "account_tier": "Premium",
      "created_at": "2014-01-08T09:08:53+05:30",
      "description": "Spaceship Manufacturing Company",
      "domains": [
        "supernova",
        "nova"
      ],
      "health_score": "Happy",
      "id": "8",
      "industry": "",
      "name": "SuperNova",
      "note": "",
      "renewal_date": "2020-12-31",
      "updated_at": "2014-01-08T09:08:53+05:30"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_page": 0
}

List groups

List the groups tickets are routed to. Needs an admin's API key.

Inputs

Page sizelimitnumber
How many to return, 1 to 100. Defaults to 30.From 1 to 100.
Pagepagenumber
Which page to get. Use 'next_page' from the step before.At least 1.

Outputs

countnumber
How many are returned
groupslist
The groups
has_moretrue/false
Whether there is another page
next_pagenumber
The next page's number, 0 when there is none
Example output
{
  "count": 1,
  "groups": [
    {
      "created_at": "2014-01-08T07:53:41+05:30",
      "description": "Singers dancers and stand up comedians",
      "id": "1",
      "name": "Entertainers"
    }
  ],
  "has_more": false,
  "next_page": 0
}

List replies and notes

List a ticket's replies and notes, oldest first.

Inputs

Ticketticket_idtextRequired
The ticket's number, from a trigger, 'Create ticket' or a list step. Its page address works too.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 30.From 1 to 100.
Pagepagenumber
Which page to get. Use 'next_page' from the step before.At least 1.

Outputs

conversationslist
The replies and notes
countnumber
How many are returned
has_moretrue/false
Whether there is another page
next_pagenumber
The next page's number, 0 when there is none
Example output
{
  "conversations": [
    {
      "body": "<div>Please reply as soon as possible.</div>",
      "body_text": "Please reply as soon as possible.",
      "cc_emails": [
        "example@ccemail.com"
      ],
      "created_at": "2015-08-24T11:59:05Z",
      "from_email": "agent2@yourcompany.com",
      "id": "3",
      "incoming": false,
      "kind": "note",
      "private": true,
      "ticket_id": "20",
      "to_emails": [
        "agent1@yourcompany.com"
      ],
      "updated_at": "2015-08-24T11:59:05Z",
      "user_id": "1"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_page": 0
}

List tickets

List tickets, newest first, for a requester, a company or a view, or those changed since a time.

Inputs

Viewviewtext
Only the tickets in one of Freshdesk's views.One of: new_and_my_open (New and my open tickets), watching (Tickets I'm watching), spam, deleted (Deleted (in Trash)).
Requester contactrequester_idtext
Only tickets from this contact (their id).
Requester emailrequester_emailtext
Only tickets from this email address.
Companycompany_idtext
Only tickets of this company.
Updated sinceupdated_sincedate and time
Only tickets changed at or after this time. Without it, Freshdesk lists only tickets created in the last 30 days.
Ordersorttext
Which tickets come first.One of: newest (Newest first (default)), oldest (Oldest first), recently_updated (Recently updated first), due_soonest (Due soonest first). Default: newest.
Include descriptionsinclude_descriptiontrue/false
Also return each ticket's description. It costs two more of your plan's API calls.Default: false.
Page sizelimitnumber
How many to return, 1 to 100. Defaults to 30.From 1 to 100.
Pagepagenumber
Which page to get. Use 'next_page' from the step before.At least 1.

Outputs

countnumber
How many are returned
has_moretrue/false
Whether there is another page
next_pagenumber
The next page's number, 0 when there is none
ticketslist
The tickets
Example output
{
  "count": 1,
  "has_more": false,
  "next_page": 0,
  "tickets": [
    {
      "cc_emails": [
        "user@cc.com",
        "user2@cc.com"
      ],
      "company_id": "",
      "created_at": "2015-08-17T12:02:50Z",
      "custom_fields": {
        "category": "Default"
      },
      "description": "",
      "description_text": "",
      "due_by": "2015-08-20T11:30:00Z",
      "fr_due_by": "2015-08-18T11:30:00Z",
      "group_id": "2",
      "id": "18",
      "is_escalated": false,
      "priority": 1,
      "priority_name": "Low",
      "requester_email": "",
      "requester_id": "5",
      "requester_name": "",
      "responder_id": "1",
      "source": 2,
      "source_name": "Portal",
      "spam": false,
      "status": 2,
      "status_name": "Open",
      "subject": "Please help",
      "tags": [],
      "type": "Lead",
      "updated_at": "2015-08-17T12:02:51Z",
      "url": "https://acme.freshdesk.com/a/tickets/18"
    }
  ]
}

Merge tickets

Merge tickets about the same issue into one. The others are closed, with a note pointing to it.

Inputs

Keep ticketprimary_ticket_idtextRequired
The ticket the others are merged into.
Tickets to mergeticket_idslistRequired
The numbers of the tickets to merge into it.
Copy their requestersconvert_recipients_to_cctrue/false
Add the merged tickets' requesters to the kept ticket's CC.Default: false.

Outputs

mergedtrue/false
Always true
merged_ticket_idslist
The tickets merged into it
primary_ticket_idtext
The ticket kept
Example output
{
  "merged": true,
  "merged_ticket_ids": [
    "21",
    "22"
  ],
  "primary_ticket_id": "20"
}

Reply to ticket

Email a reply to the ticket's requester, from your support address.

Inputs

Ticketticket_idtextRequired
The ticket's number, from a trigger, 'Create ticket' or a list step. Its page address works too.
ReplybodytextRequired
What to say. Line breaks are kept.
CCcc_emailslist
Email addresses to copy.
BCCbcc_emailslist
Email addresses to blind copy.

Outputs

conversationobject
The reply or note
Example output
{
  "conversation": {
    "body": "<div>We are working on this issue. Will keep you posted.</div>",
    "body_text": "We are working on this issue. Will keep you posted.",
    "cc_emails": [],
    "created_at": "2015-08-24T13:36:42Z",
    "from_email": "support@yourcompany.com",
    "id": "4",
    "incoming": false,
    "kind": "reply",
    "private": false,
    "ticket_id": "141",
    "to_emails": [
      "sample@yourcustomer.com"
    ],
    "updated_at": "2015-08-24T13:36:42Z",
    "user_id": "1"
  }
}

Search knowledge base

Find knowledge base articles that mention a word or phrase.

Inputs

Search fortermtextRequired
A word or phrase, such as reset password.

Outputs

articleslist
The matching articles
countnumber
How many are returned
Example output
{
  "articles": [
    {
      "category_name": "sample category",
      "created_at": "2016-09-09T02:07:56Z",
      "description_text": "sample description",
      "folder_name": "sample folder",
      "id": "2",
      "status": "published",
      "title": "sample article",
      "updated_at": "2016-09-09T07:07:56Z",
      "url": "https://acme.freshdesk.com/support/solutions/articles/2"
    }
  ],
  "count": 1
}

Update company

Change a company's details. Only the fields filled in change; email domains given replace the old ones.

Inputs

Companycompany_idtextRequired
Pick a company, or give its id from an earlier step.
Namenametext
A new name. Leave empty to keep it.
Email domainsdomainslist
Domains such as acme.com. Contacts with an email address there join the company.
Descriptiondescriptiontext
What the company does.
Notenotetext
A note for your team.
Health scorehealth_scoretext
One of your account's health scores, such as Happy or At risk.
Account tieraccount_tiertext
One of your account's tiers, such as Basic, Premium or Enterprise.
Industryindustrytext
One of your account's industries, such as Retail.
Renewal daterenewal_datedate
When their contract renews.

Outputs

companyobject
The company
Example output
{
  "company": {
    "account_tier": "Premium",
    "created_at": "2014-01-08T09:08:53+05:30",
    "description": "Spaceship Manufacturing Company",
    "domains": [
      "supernova",
      "nova"
    ],
    "health_score": "Happy",
    "id": "8",
    "industry": "",
    "name": "SuperNova",
    "note": "",
    "renewal_date": "2020-12-31",
    "updated_at": "2014-01-08T09:08:53+05:30"
  }
}

Update contact

Change a contact's details. Only the fields filled in change.

Inputs

Contactcontact_idtextRequired
The contact's id, from 'Find contacts', 'Create contact' or a trigger.
Namenametext
A new name. Leave empty to keep it.
Emailemailtext
Their main email address.
Phonephonetext
Phone number.
Mobilemobiletext
Mobile number.
Companycompany_idtext
The company they work for.
Job titlejob_titletext
Job title.
Addressaddresstext
Postal address.
Aboutdescriptiontext
A short description of them.
External IDunique_external_idtext
Your own id for them, such as their id in your CRM.
Tags to addadd_tagslist
Tags to add. The contact's other tags stay.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "address": "",
    "company_id": "23",
    "created_at": "2015-08-28T09:08:16Z",
    "deleted": false,
    "description": "",
    "email": "superman@freshdesk.com",
    "id": "432",
    "job_title": "",
    "language": "en",
    "mobile": "",
    "name": "Super Man",
    "other_emails": [
      "lex@freshdesk.com",
      "louis@freshdesk.com"
    ],
    "phone": "",
    "tags": [],
    "time_zone": "Chennai",
    "unique_external_id": "",
    "updated_at": "2015-08-28T09:08:16Z",
    "verified": false
  }
}

Update ticket

Change a ticket's status, priority, assignment, type, tags or other fields. Only the fields filled in change.

Inputs

Ticketticket_idtextRequired
The ticket's number, from a trigger, 'Create ticket' or a list step. Its page address works too.
Subjectsubjecttext
A new subject. Leave empty to keep it.
Descriptiondescriptiontext
A new description. Leave empty to keep it.
Statusstatustext
A new status, such as Resolved.
Priorityprioritytext
A new priority.One of: 1 (Low), 2 (Medium), 3 (High), 4 (Urgent).
Typeticket_typetext
A new type.
Groupgroup_idtext
Move it to this group.
Agentresponder_idtext
Assign it to this agent.
Companycompany_idtext
Change the company it belongs to.
Tags to addadd_tagslist
Tags to add. The ticket's other tags stay.
Due bydue_bydate and time
When the ticket must be resolved. Leave empty to follow your SLA.
First response due byfr_due_bydate and time
When the first reply is due. Must be before 'Due by'. Leave empty to follow your SLA.
Custom fieldscustom_fieldsobject
Values for your own ticket fields. Fields left blank are not changed.

Outputs

ticketobject
The ticket
Example output
{
  "ticket": {
    "cc_emails": [
      "user@cc.com"
    ],
    "company_id": "1",
    "created_at": "2015-08-24T11:56:51Z",
    "custom_fields": {
      "category": "Primary"
    },
    "description": "<div>Not given.</div>",
    "description_text": "Not given.",
    "due_by": "2015-08-27T11:30:00Z",
    "fr_due_by": "2015-08-25T11:30:00Z",
    "group_id": "",
    "id": "20",
    "is_escalated": false,
    "priority": 1,
    "priority_name": "Low",
    "requester_email": "test@test.com",
    "requester_id": "1",
    "requester_name": "Rachel",
    "responder_id": "",
    "source": 2,
    "source_name": "Portal",
    "spam": false,
    "status": 4,
    "status_name": "Resolved",
    "subject": "",
    "tags": [],
    "type": "",
    "updated_at": "2015-08-24T11:59:05Z",
    "url": "https://acme.freshdesk.com/a/tickets/20"
  }
}

On this page