Class: Freshdesk

Methods

createCompany(data, cb) → {void}

Creates company.

Parameters:

Source:

• client.js, line 641

See:

• http://developer.freshdesk.com/api/#create_company

Returns:

Type

void

createSolutionArticle(id, data, cb)

Create a Solution Article

Parameters:

Source:

• client.js, line 1511

See:

• https://developer.freshdesk.com/api/#create_solution_article

createSolutionCategory(data, cb)

Create a Solution Category

Parameters:

Source:

• client.js, line 1065

See:

• https://developer.freshdesk.com/api/#create_solution_category

createSolutionFolder(id, data, cb)

Create a Solution Folder

Parameters:

Source:

• client.js, line 1285

See:

• https://developer.freshdesk.com/api/#create_solution_folder

createTimeEntry(ticket_id, data, cb)

Create a Time Entry

Note:

1. If the time_spent is not specified and the timer_running attribute is not specified, then the timer_running attribute will automatically be set to true
2. If the start_time is specified and the timer_running attribute is not specified, then the timer_running attribute will automatically be set to true
3. The start_time cannot be greater than the current time
4. The start_time cannot be given in the API request if the timer_running attribute is set to false

Parameters:

Source:

• client.js, line 889

See:

• https://developer.freshdesk.com/api/#create_time_entry

createTranslatedSolutionArticle(id, language_code, data, cb)

Create a translated solution article

Note:

1. Multilingual Feature must be enabled for the account
2. Supported languages have to be configured from Admin > General Settings > Helpdesk
3. Configured languages can be retrieved from Helpdesk Settings

Parameters:

Source:

• client.js, line 1539

See:

• https://developer.freshdesk.com/api/#create_solution_article

createTranslatedSolutionCategory(id, language_code, data, cb)

Create a translated solution category

Note:

1. Multilingual Feature must be enabled for the account
2. Supported languages have to be configured from Admin > General Settings > Helpdesk
3. Configured languages can be retrieved from Helpdesk Settings

Parameters:

Source:

• client.js, line 1093

See:

• https://developer.freshdesk.com/api/#create_solution_category

createTranslatedSolutionFolder(id, language_code, data, cb)

Create a translated solution folder

Note:

1. Multilingual Feature must be enabled for the account
2. Supported languages have to be configured from Admin > General Settings > Helpdesk
3. Configured languages can be retrieved from Helpdesk Settings

Parameters:

Source:

• client.js, line 1313

See:

• https://developer.freshdesk.com/api/#create_solution_folder

currentAgent(cb)

Currently Authenticated Agent.

Parameters:

Source:

• client.js, line 543

See:

• https://developers.freshdesk.com/api/#me

deleteAgent(id, cb)

Delete an Agent.

Parameters:

Source:

• client.js, line 522

See:

• https://developers.freshdesk.com/api/#delete_agent

deleteCompany(id, cb)

Delete a Company.

Parameters:

Source:

• client.js, line 821

See:

• http://developer.freshdesk.com/api/#delete_company

deleteSolutionArticle(id, cb)

Delete a Solution Article

Note: When deleted, all translated versions will be deleted too.

Parameters:

Source:

• client.js, line 1677

See:

• https://developer.freshdesk.com/api/#delete_solution_article

deleteSolutionCategory(id, cb)

Delete a Solution Category

Note: When deleted, all translated versions will be deleted too.

Parameters:

Source:

• client.js, line 1230

See:

• https://developer.freshdesk.com/api/#delete_solution_category

deleteSolutionFolder(id, cb)

Delete a Solution Folder

Note: When deleted, all translated versions will be deleted too.

Parameters:

Source:

• client.js, line 1451

See:

• https://developer.freshdesk.com/api/#delete_solution_folder

deleteTimeEntry(id, cb)

Delete a Time Entry

Note: Deleted time entries cannot be restored.

Parameters:

Source:

• client.js, line 1013

See:

• https://developer.freshdesk.com/api/#delete_time_entry

filterCompanies(query, cb)

Filter Companies.

Parameters:

Source:

• client.js, line 761

See:

• https://developer.freshdesk.com/api/#filter_companies

filterContacts(query, cb)

Filter Contacts.

Parameters:

Source:

• client.js, line 365

See:

• https://developer.freshdesk.com/api/#filter_contacts

filterTickets(query, page, cb)

Filter tickets

Parameters:

Source:

• client.js, line 103

getAgent(id, cb)

View an Agent.

Parameters:

Source:

• client.js, line 455

See:

• https://developers.freshdesk.com/api/#view_agent

getCompany(id, cb)

View a Company.

Parameters:

Source:

• client.js, line 663

See:

• http://developer.freshdesk.com/api/#view_company

getRole(id, cb)

View a Role.

Parameters:

Source:

• client.js, line 566

See:

• https://developers.freshdesk.com/api/#view_role

getSettings(cb)

View Helpdesk Settings

Parameters:

Source:

• client.js, line 1722

See:

• https://developer.freshdesk.com/api/#settings

getSolutionArticle(id, cb)

View a Solution Article

Parameters:

Source:

• client.js, line 1610

See:

• https://developer.freshdesk.com/api/#view_solution_article

getSolutionCategory(id, cb)

View a Solution Category

Parameters:

Source:

• client.js, line 1164

See:

• https://developer.freshdesk.com/api/#view_solution_category

getSolutionFolder(id, cb)

View a Solution Folder

Parameters:

Source:

• client.js, line 1384

See:

• https://developer.freshdesk.com/api/#view_solution_folder

getTranslatedSolutionArticle(id, language_code, cb)

View a translated Solution Article

Parameters:

Source:

• client.js, line 1632

See:

• https://developer.freshdesk.com/api/#view_solution_article

getTranslatedSolutionCategory(id, language_code, cb)

View a translated solution Category

Parameters:

Source:

• client.js, line 1186

See:

• https://developer.freshdesk.com/api/#view_solution_category

getTranslatedSolutionFolder(id, language_code, cb)

View a translated solution Folder

Parameters:

Source:

• client.js, line 1406

See:

• https://developer.freshdesk.com/api/#view_solution_folder

listAllAgents(params, cb)

List All Agents.

Parameters:

Source:

• client.js, line 477

See:

• https://developers.freshdesk.com/api/#list_all_agents

listAllCompanies(params, cb)

List All Companies.

Parameters:

Source:

• client.js, line 720

See:

• http://developer.freshdesk.com/api/#list_all_companies

listAllRoles(cb) → {void}

List All Roles.

Parameters:

Source:

• client.js, line 587

See:

• https://developers.freshdesk.com/api/#list_all_roles

Returns:

Type

void

listAllSolutionCategories(cb)

List all Solution Categories

Parameters:

Source:

• client.js, line 1206

See:

• https://developer.freshdesk.com/api/#list_all_solution_categories

listAllSolutionCategoryFolders(id, cb)

List all Solution Folders in a Category

Parameters:

Source:

• client.js, line 1427

See:

• https://developer.freshdesk.com/api/#list_all_solution_folders

listAllSolutionFolderArticles(id, cb)

List all Solution Articles in a Folder

Parameters:

Source:

• client.js, line 1653

See:

• https://developer.freshdesk.com/api/#list_all_solution_articles

listAllTickets(params, cb)

listAllTickets API method.

Parameters:

Source:

• client.js, line 86

See:

• http://developers.freshdesk.com/api/#list_all_tickets

listAllTimeEntries(params, cb)

List All Time Entries

Parameters:

Source:

• client.js, line 916

See:

• https://developer.freshdesk.com/api/#list_all_time_entries

searchCompany(params, cb)

Search Companies.

Parameters:

Source:

• client.js, line 685

See:

• https://developers.freshdesk.com/api/#search_companies

searchSolutionArticles(term, cb)

Search solution articles

Parameters:

Source:

• client.js, line 1698

See:

• https://developer.freshdesk.com/api/#search_solution_article

toggleTimer(id, cb)

Start/Stop Timer

Parameters:

Source:

• client.js, line 989

See:

• https://developer.freshdesk.com/api/#toggle_time_entry

updateAgent(id, data, cb)

Update an Agent.

Parameters:

Source:

• client.js, line 500

See:

• https://developers.freshdesk.com/api/#update_agent

updateCompany(id, data, cb) → {void}

Updates company.

Parameters:

Source:

• client.js, line 796

See:

• http://developer.freshdesk.com/api/#update_company

Returns:

Type

void

updateSolutionArticle(id, data, cb)

Update a Solution Article

Parameters:

Source:

• client.js, line 1561

See:

• https://developer.freshdesk.com/api/#update_solution_article

updateSolutionCategory(id, data, cb)

Update a Solution Category

Parameters:

Source:

• client.js, line 1115

See:

• https://developer.freshdesk.com/api/#update_solution_category

updateSolutionFolder(id, data, cb)

Update a Solution Folder

Parameters:

Source:

• client.js, line 1335

See:

• https://developer.freshdesk.com/api/#update_solution_folder

updateTimeEntry(id, data, cb)

Update a Time Entry

Note:

1. The start_time cannot be updated if the timer is already running
2. The start_time cannot be be updated unless the timer_running attribute is updated from true to false
3. The start_time cannot be greater than the current time
4. The timer_running attribute cannot be set to the same value as before
5. The agent_id cannot be updated if the timer is already running

Parameters:

Source:

• client.js, line 967

See:

• https://developer.freshdesk.com/api/#update_time_entry

updateTranslatedSolutionArticle(id, language_code, data, cb)

Update a translated solution article

Note:

1. Multilingual Feature must be enabled for the account
2. Supported languages have to be configured from Admin > General Settings > Helpdesk
3. Configured languages can be retrieved from Helpdesk Settings

Parameters:

Source:

• client.js, line 1589

See:

• https://developer.freshdesk.com/api/#update_solution_article

updateTranslatedSolutionCategory(id, language_code, data, cb)

Update a translated solution category

Note:

1. Multilingual Feature must be enabled for the account
2. Supported languages have to be configured from Admin > General Settings > Helpdesk
3. Configured languages can be retrieved from Helpdesk Settings

Parameters:

Source:

• client.js, line 1143

See:

• https://developer.freshdesk.com/api/#update_solution_category

updateTranslatedSolutionFolder(id, language_code, data, cb)

Update a translated solution folder

Note:

1. Multilingual Feature must be enabled for the account
2. Supported languages have to be configured from Admin > General Settings > Helpdesk
3. Configured languages can be retrieved from Helpdesk Settings

Parameters:

Source:

• client.js, line 1363

See:

• https://developer.freshdesk.com/api/#update_solution_folder