Freshdesk actions & endpoints
Last updated
Was this helpful?
Last updated
Was this helpful?
The Freshdesk Integration with Rewst delivers a robust set of actions and endpoints for interacting with Freshdesk. Below is a summary of each section, highlighting the diverse capabilities and opportunities provided through the Freshdesk Integration:
GET <example>.freshdesk.com/agents
List all agents (users) matching the supplied parameters
GET <example>.freshdesk.com/agents/{agent_id}
Get an agent (user) by ID
GET <example>.freshdesk.com/companies
List all companies
GET <example>.freshdesk.com/companies/autocomplete
Search for a company using its name
GET <example>.freshdesk.com/search/companies
(Beta) Use custom company fields that you have created in your account to filter through the companies and get a list of companies matching the specified company fields
GET <example>.freshdesk.com/companies/{company_id}
Get a company by ID
POST <example>.freshdesk.com/companies
Adds a new company in Freshdesk
PUT <example>.freshdesk.com/companies/{company_id}
Updates a company by ID
DELETE <example>.freshdesk.com/companies/{company_id}
Deletes a company by ID, once deleted a company cannot be restored. Deleting a company does not delete the contacts that are associated with it.
GET <example>.freshdesk.com/contacts
List all contacts, use filters to view only specific contacts
GET <example>.freshdesk.com/contacts/autocomplete
Search for a contact using their name
GET <example>.freshdesk.com/search/contacts
(Beta) Use custom contact fields that you have created in your account to filter through the contacts and get a list of contacts matching the specified contact fields
GET <example>.freshdesk.com/contacts/{contact_id}
Get a contact by ID
POST <example>.freshdesk.com/contacts
Adds a new contact record
PUT <example>.freshdesk.com/contacts/{contact_id}
Update a contact by ID
DELETE <example>.freshdesk.com/contacts/{contact_id}
Soft delete a contact by ID
DELETE <example>.freshdesk.com/contacts/{contact_id}/hard_delete
Hard delete a contact to completely remove it from the portal. Can be used for GDPR compliance.
PUT <example>.freshdesk.com/contacts/{contact_id}/restore
Used to restore contacts that have been soft-deleted from a Freshdesk account
PUT <example>.freshdesk.com/contacts/{contact_id}/send_invite
Used to send an activation email to an existing contact for email verification. Once the activation is complete, these contacts can log in to the customer portal using their password and check the status of their tickets.
PUT <example>.freshdesk.com/contacts/{contact_id}/make_agent
Makes a new Agent for an existing Contact
POST <example>.freshdesk.com/tickets/{ticket_id}/reply
Create a reply to a ticket or conversation
POST <example>.freshdesk.com/tickets/{ticket_id}/notes
Create a note for a ticket
GET <example>.freshdesk.com/<url_path>
Generic action for making authenticated requests against the Freshdesk API
GET <example>.freshdesk.com/groups
List all groups
GET <example>.freshdesk.com/groups/{group_id}
Get a single group by ID
GET <example>.freshdesk.com/roles
List all roles
GET <example>.freshdesk.com/roles/{role_id}
Get a single role by ID
GET <example>.freshdesk.com/skills
List all skills
GET <example>.freshdesk.com/skills/{skill_id}
Get a single skill by ID
POST <example>.freshdesk.com/tickets
Create Freshdesk Ticket
GET <example>.freshdesk.com/tickets
List Freshdesk Tickets
GET <example>.freshdesk.com/tickets/{ticket_id}
Get Freshdesk Ticket
PUT <example>.freshdesk.com/tickets/{ticket_id}
Update Freshdesk Ticket
GET <example>.freshdesk.com/time_entries
List all time entries created by agents. Use filters to view only specific time entries.
POST <example>.freshdesk.com/tickets/{ticket_id}/time_entries
Adds a new time entry to a given ticket
PUT <example>.freshdesk.com/time_entries/{time_entry_id}
Update a single time entry by ID
PUT <example>.freshdesk.com/time_entries/{time_entry_id}/toggle_timer
Start or stop the timer for a given time entry
DELETE <example>.freshdesk.com/time_entries/{time_entry_id}
Permanently deletes a given time entry, note that once deleted time entries cannot be restored.