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
Create a contact
Parameters:
Parameter Type Required Default Description addressstring No — Mailing address company_idinteger No — ID of the associated company custom_fieldsobject No — Custom field key-value pairs descriptionstring No — Description or notes emailstring No — Primary email address facebook_idstring No — Facebook ID job_titlestring No — Job title languagestring No — Language preference mobilestring No — Mobile number namestring Yes — Name of the contact other_companiesobject[] No — Additional companies other_emailsstring[] No — Additional email addresses phonestring No — Phone number tagsstring[] No — Tags to associate time_zonestring No — Timezone twitter_idstring No — Twitter handle
{
"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"
},
"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"
]
}
Delete a contact
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the contact to delete
{
"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"
]
}
Export contacts
Parameters:
Parameter Type Required Default Description custom_fieldsobject No — Custom contact fields to include in the export default_fieldsobject No — Default contact fields to include in the export
{
"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"
]
}
Get a contact
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the contact
{
"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"
]
}
List all contact fields
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
List all contacts
Parameters:
Parameter Type Required Default Description emailstring No — Filter by email address mobilestring No — Filter by mobile number phonestring No — Filter by phone number company_idinteger No — Filter by company ID statestring No — Filter by state: verified, unverified, blocked, deleted updated_sincestring No — Return contacts updated since this date-time pageinteger No — Page number for pagination per_pageinteger No — Number of results per page (max 100)
{
"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"
]
}
Convert contact to agent
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the contact to convert occasionalboolean No — Whether the new agent should be an occasional (day pass) agent
{
"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"
]
}
Merge contacts
Parameters:
Parameter Type Required Default Description primary_contact_idinteger Yes — ID of the primary contact to merge into secondary_contact_idsinteger[] Yes — IDs of secondary contacts to merge
{
"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"
]
}
Restore a deleted contact
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the contact to restore
{
"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"
]
}
Search contacts
Parameters:
Parameter Type Required Default Description querystring 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. pageinteger No — Page number for pagination
{
"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"
]
}
Send portal invite to contact
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the contact
{
"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"
]
}
Update a contact
Parameters:
Parameter Type Required Default Description idinteger Yes — ID of the contact to update addressstring No — Mailing address company_idinteger No — ID of the associated company custom_fieldsobject No — Custom field key-value pairs descriptionstring No — Description or notes emailstring No — Primary email address facebook_idstring No — Facebook ID job_titlestring No — Job title languagestring No — Language preference mobilestring No — Mobile number namestring No — Name of the contact other_emailsstring[] No — Additional email addresses phonestring No — Phone number tagsstring[] No — Tags to associate time_zonestring No — Timezone twitter_idstring No — Twitter handle
{
"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"
]
}