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

Tools


freshdesk_solutions_create_solution_article

Create a solution article Parameters:
ParameterTypeRequiredDefaultDescription
folder_idintegerYesID of the parent folder
agent_idintegerNoID of the agent author
descriptionstringYesHTML content of the article
seo_dataobjectNoSEO metadata
statusintegerYesStatus: 1=Draft, 2=Published
tagsstring[]NoTags to associate
titlestringYesTitle of the article
typeintegerNoType: 1=Permanent, 2=Workaround

freshdesk_solutions_create_solution_category

Create a solution category Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoThe description value
namestringYesName of the category
visible_in_portalsinteger[]NoPortal IDs where this category should be visible

freshdesk_solutions_create_solution_folder

Create a solution folder Parameters:
ParameterTypeRequiredDefaultDescription
category_idintegerYesID of the parent category
company_idsinteger[]NoCompany IDs (required when visibility=4)
descriptionstringNoThe description value
namestringYesName of the folder
visibilityintegerYesVisibility: 1=All users, 2=Logged-in users, 3=Agents only, 4=Selected companies

freshdesk_solutions_delete_solution_article

Delete a solution article Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the solution article to delete

freshdesk_solutions_delete_solution_category

Delete a solution category Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the solution category to delete

freshdesk_solutions_delete_solution_folder

Delete a solution folder Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the solution folder to delete

freshdesk_solutions_get_solution_article

Get a solution article Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the solution article

freshdesk_solutions_get_solution_category

Get a solution category Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the solution category

freshdesk_solutions_get_solution_folder

Get a solution folder Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the solution folder

freshdesk_solutions_list_solution_articles

List solution articles in a folder Parameters:
ParameterTypeRequiredDefaultDescription
folder_idintegerYesID of the parent folder

freshdesk_solutions_list_solution_categories

List all solution categories

freshdesk_solutions_list_solution_folders

List solution folders in a category Parameters:
ParameterTypeRequiredDefaultDescription
category_idintegerYesID of the parent category

freshdesk_solutions_search_solution_articles

Search solution articles Parameters:
ParameterTypeRequiredDefaultDescription
termstringYesSearch keyword or phrase

freshdesk_solutions_update_solution_article

Update a solution article Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the solution article to update
agent_idintegerNoID of the agent author
descriptionstringNoHTML content of the article
seo_dataobjectNoSEO metadata
statusintegerNoStatus: 1=Draft, 2=Published
tagsstring[]NoTags to associate
titlestringNoTitle of the article
typeintegerNoType: 1=Permanent, 2=Workaround

freshdesk_solutions_update_solution_category

Update a solution category Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the solution category to update
descriptionstringNoThe description value
namestringNoName of the category
visible_in_portalsinteger[]NoPortal IDs where this category should be visible

freshdesk_solutions_update_solution_folder

Update a solution folder Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the solution folder to update
company_idsinteger[]NoCompany IDs (required when visibility=4)
descriptionstringNoThe description value
namestringNoName of the folder
visibilityintegerNoVisibility: 1=All users, 2=Logged-in users, 3=Agents only, 4=Selected companies