Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

Server path: /freshdesk-contacts | Type: Application | PCID required: Yes

Tools


freshdesk_contacts_create_contact

Create a contact Parameters:
ParameterTypeRequiredDefaultDescription
addressstringNoMailing address
company_idintegerNoID of the associated company
custom_fieldsobjectNoCustom field key-value pairs
descriptionstringNoDescription or notes
emailstringNoPrimary email address
facebook_idstringNoFacebook ID
job_titlestringNoJob title
languagestringNoLanguage preference
mobilestringNoMobile number
namestringYesName of the contact
other_companiesobject[]NoAdditional companies
other_emailsstring[]NoAdditional email addresses
phonestringNoPhone number
tagsstring[]NoTags to associate
time_zonestringNoTimezone
twitter_idstringNoTwitter handle

freshdesk_contacts_delete_contact

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

freshdesk_contacts_export_contacts

Export contacts Parameters:
ParameterTypeRequiredDefaultDescription
custom_fieldsobjectNoCustom contact fields to include in the export
default_fieldsobjectNoDefault contact fields to include in the export

freshdesk_contacts_get_contact

Get a contact Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the contact

freshdesk_contacts_list_contact_fields

List all contact fields

freshdesk_contacts_list_contacts

List all contacts Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoFilter by email address
mobilestringNoFilter by mobile number
phonestringNoFilter by phone number
company_idintegerNoFilter by company ID
statestringNoFilter by state: verified, unverified, blocked, deleted
updated_sincestringNoReturn contacts updated since this date-time
pageintegerNoPage number for pagination
per_pageintegerNoNumber of results per page (max 100)

freshdesk_contacts_make_contact_agent

Convert contact to agent Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the contact to convert
occasionalbooleanNoWhether the new agent should be an occasional (day pass) agent

freshdesk_contacts_merge_contacts

Merge contacts Parameters:
ParameterTypeRequiredDefaultDescription
primary_contact_idintegerYesID of the primary contact to merge into
secondary_contact_idsinteger[]YesIDs of secondary contacts to merge

freshdesk_contacts_restore_contact

Restore a deleted contact Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the contact to restore

freshdesk_contacts_search_contacts

Search contacts 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_contacts_send_contact_invite

Send portal invite to contact Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the contact

freshdesk_contacts_update_contact

Update a contact Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesID of the contact to update
addressstringNoMailing address
company_idintegerNoID of the associated company
custom_fieldsobjectNoCustom field key-value pairs
descriptionstringNoDescription or notes
emailstringNoPrimary email address
facebook_idstringNoFacebook ID
job_titlestringNoJob title
languagestringNoLanguage preference
mobilestringNoMobile number
namestringNoName of the contact
other_emailsstring[]NoAdditional email addresses
phonestringNoPhone number
tagsstring[]NoTags to associate
time_zonestringNoTimezone
twitter_idstringNoTwitter handle