/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_export_contacts | Export contacts |
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_make_contact_agent | Convert contact to agent |
freshdesk_contacts_merge_contacts | Merge contacts |
freshdesk_contacts_restore_contact | Restore a deleted contact |
freshdesk_contacts_search_contacts | Search contacts |
freshdesk_contacts_send_contact_invite | Send portal invite to contact |
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"address": {
"type": "string",
"description": "Mailing address"
},
"company_id": {
"type": "integer",
"description": "ID of the associated company"
},
"custom_fields": {
"type": "object",
"description": "Custom field key-value pairs"
},
"description": {
"type": "string",
"description": "Description or notes"
},
"email": {
"type": "string",
"description": "Primary email address"
},
"facebook_id": {
"type": "string",
"description": "Facebook ID"
},
"job_title": {
"type": "string",
"description": "Job title"
},
"language": {
"type": "string",
"description": "Language preference"
},
"mobile": {
"type": "string",
"description": "Mobile number"
},
"name": {
"type": "string",
"description": "Name of the contact"
},
"other_companies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"company_id": {
"type": "integer",
"description": "Company Id"
},
"view_all_tickets": {
"type": "boolean",
"description": "View All Tickets"
}
}
},
"description": "Additional companies"
},
"other_emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Additional email addresses"
},
"phone": {
"type": "string",
"description": "Phone number"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to associate"
},
"time_zone": {
"type": "string",
"description": "Timezone"
},
"twitter_id": {
"type": "string",
"description": "Twitter handle"
}
},
"required": [
"PCID",
"name"
]
}
freshdesk_contacts_delete_contact
Delete a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the contact to delete |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the contact to delete"
}
},
"required": [
"PCID",
"id"
]
}
freshdesk_contacts_export_contacts
Export contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
custom_fields | object | No | — | Custom contact fields to include in the export |
default_fields | object | No | — | Default contact fields to include in the export |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"custom_fields": {
"type": "object",
"description": "Custom contact fields to include in the export"
},
"default_fields": {
"type": "object",
"description": "Default contact fields to include in the export"
}
},
"required": [
"PCID"
]
}
freshdesk_contacts_get_contact
Get a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the contact |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the contact"
}
},
"required": [
"PCID",
"id"
]
}
freshdesk_contacts_list_contact_fields
List all contact fieldsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
freshdesk_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) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email": {
"type": "string",
"description": "Filter by email address"
},
"mobile": {
"type": "string",
"description": "Filter by mobile number"
},
"phone": {
"type": "string",
"description": "Filter by phone number"
},
"company_id": {
"type": "integer",
"description": "Filter by company ID"
},
"state": {
"type": "string",
"description": "Filter by state: verified, unverified, blocked, deleted"
},
"updated_since": {
"type": "string",
"description": "Return contacts updated since this date-time"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"per_page": {
"type": "integer",
"description": "Number of results per page (max 100)"
}
},
"required": [
"PCID"
]
}
freshdesk_contacts_make_contact_agent
Convert contact to agent Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the contact to convert |
occasional | boolean | No | — | Whether the new agent should be an occasional (day pass) agent |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the contact to convert"
},
"occasional": {
"type": "boolean",
"description": "Whether the new agent should be an occasional (day pass) agent"
}
},
"required": [
"PCID",
"id"
]
}
freshdesk_contacts_merge_contacts
Merge contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
primary_contact_id | integer | Yes | — | ID of the primary contact to merge into |
secondary_contact_ids | integer[] | Yes | — | IDs of secondary contacts to merge |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"primary_contact_id": {
"type": "integer",
"description": "ID of the primary contact to merge into"
},
"secondary_contact_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of secondary contacts to merge"
}
},
"required": [
"PCID",
"primary_contact_id",
"secondary_contact_ids"
]
}
freshdesk_contacts_restore_contact
Restore a deleted contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the contact to restore |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the contact to restore"
}
},
"required": [
"PCID",
"id"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"query": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "Page number for pagination"
}
},
"required": [
"PCID",
"query"
]
}
freshdesk_contacts_send_contact_invite
Send portal invite to contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | ID of the contact |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the contact"
}
},
"required": [
"PCID",
"id"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "ID of the contact to update"
},
"address": {
"type": "string",
"description": "Mailing address"
},
"company_id": {
"type": "integer",
"description": "ID of the associated company"
},
"custom_fields": {
"type": "object",
"description": "Custom field key-value pairs"
},
"description": {
"type": "string",
"description": "Description or notes"
},
"email": {
"type": "string",
"description": "Primary email address"
},
"facebook_id": {
"type": "string",
"description": "Facebook ID"
},
"job_title": {
"type": "string",
"description": "Job title"
},
"language": {
"type": "string",
"description": "Language preference"
},
"mobile": {
"type": "string",
"description": "Mobile number"
},
"name": {
"type": "string",
"description": "Name of the contact"
},
"other_emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Additional email addresses"
},
"phone": {
"type": "string",
"description": "Phone number"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to associate"
},
"time_zone": {
"type": "string",
"description": "Timezone"
},
"twitter_id": {
"type": "string",
"description": "Twitter handle"
}
},
"required": [
"PCID",
"id"
]
}