/freshdesk-contacts | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
freshdesk_contacts_create_contact | Create a contact |
freshdesk_contacts_delete_contact | Delete a contact |
freshdesk_contacts_get_contact | Get a contact |
freshdesk_contacts_list_contact_fields | List all contact fields |
freshdesk_contacts_list_contacts | List all contacts |
freshdesk_contacts_search_contacts | Search contacts |
freshdesk_contacts_update_contact | Update a contact |
freshdesk_contacts_create_contact
Create a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | string | No | — | Mailing address |
company_id | integer | No | — | ID of the associated company |
custom_fields | object | No | — | Custom field key-value pairs |
description | string | No | — | Description or notes |
email | string | No | — | Primary email address |
facebook_id | string | No | — | Facebook ID |
job_title | string | No | — | Job title |
language | string | No | — | Language preference |
mobile | string | No | — | Mobile number |
name | string | Yes | — | Name of the contact |
other_companies | object[] | No | — | Additional companies |
other_emails | string[] | No | — | Additional email addresses |
phone | string | No | — | Phone number |
tags | string[] | No | — | Tags to associate |
time_zone | string | No | — | Timezone |
twitter_id | string | No | — | Twitter handle |
freshdesk_contacts_delete_contact
Delete a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the contact to delete |
freshdesk_contacts_get_contact
Get a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the contact |
freshdesk_contacts_list_contact_fields
List all contact fieldsfreshdesk_contacts_list_contacts
List all contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Filter by email address |
mobile | string | No | — | Filter by mobile number |
phone | string | No | — | Filter by phone number |
company_id | integer | No | — | Filter by company ID |
state | string | No | — | Filter by state: verified, unverified, blocked, deleted |
updated_since | string | No | — | Return contacts updated since this date-time |
page | integer | No | — | Page number for pagination |
per_page | integer | No | — | Number of results per page (max 100) |
freshdesk_contacts_search_contacts
Search contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | Yes | — | Search 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. |
page | integer | No | — | Page number for pagination |
freshdesk_contacts_update_contact
Update a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the contact to update |
address | string | No | — | Mailing address |
company_id | integer | No | — | ID of the associated company |
custom_fields | object | No | — | Custom field key-value pairs |
description | string | No | — | Description or notes |
email | string | No | — | Primary email address |
facebook_id | string | No | — | Facebook ID |
job_title | string | No | — | Job title |
language | string | No | — | Language preference |
mobile | string | No | — | Mobile number |
name | string | No | — | Name of the contact |
other_emails | string[] | No | — | Additional email addresses |
phone | string | No | — | Phone number |
tags | string[] | No | — | Tags to associate |
time_zone | string | No | — | Timezone |
twitter_id | string | No | — | Twitter handle |

