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

Tools


freshdesk_companies_create_company

Create a company Parameters:
ParameterTypeRequiredDefaultDescription
account_tierstringNoAccount tier
custom_fieldsobjectNoCustom field key-value pairs
descriptionstringNoThe description value
domainsstring[]NoEmail domains to associate
health_scorestringNoHealth score
industrystringNoThe industry value
namestringYesName of the company
notestringNoNotes
renewal_datestringNoRenewal date

freshdesk_companies_delete_company

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

freshdesk_companies_get_company

Get a company Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the company

freshdesk_companies_list_companies

List all companies Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
per_pageintegerNoNumber of results per page (max 100)

freshdesk_companies_list_company_fields

List all company fields

freshdesk_companies_search_companies

Search companies 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

freshdesk_companies_update_company

Update a company Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the company to update
account_tierstringNoAccount tier
custom_fieldsobjectNoCustom field key-value pairs
descriptionstringNoThe description value
domainsstring[]NoEmail domains
health_scorestringNoHealth score
industrystringNoThe industry value
namestringNoName of the company
notestringNoNotes
renewal_datestringNoRenewal date