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: /zoho | Type: Application | PCID required: Yes
| Tool | Description |
|---|
zoho_create_contact | Create a new contact in Zoho CRM |
zoho_get_contact | Retrieve a contact by ID |
zoho_search_contacts | Search for contacts using various criteria |
zoho_update_contact | Update an existing contact |
zoho_create_lead | Create a new lead in Zoho CRM |
zoho_get_lead | Retrieve a lead by ID |
zoho_convert_lead | Convert a lead to contact, account, and deal |
zoho_create_deal | Create a new deal in Zoho CRM |
zoho_get_deal | Retrieve a deal by ID |
zoho_update_deal | Update an existing deal |
zoho_create_account | Create a new account in Zoho CRM |
zoho_get_account | Retrieve an account by ID |
zoho_create_task | Create a new task in Zoho CRM |
zoho_get_task | Retrieve a task by ID |
zoho_create_note | Create a note for a record in Zoho CRM |
zoho_search_records | Search for records across different modules |
zoho_get_users | Get list of users in the Zoho CRM organization |
zoho_get_fields | Get field metadata for a specific module |
zoho_create_event | Create a new event/meeting in Zoho CRM |
zoho_get_event | Retrieve an event by ID |
Create a new contact in Zoho CRM
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
firstName | string | Yes | — | Contact first name |
lastName | string | Yes | — | Contact last name |
email | string | No | — | Contact email address |
phone | string | No | — | Contact phone number |
mobile | string | No | — | Contact mobile number |
accountName | string | No | — | Associated account name |
title | string | No | — | Contact job title |
department | string | No | — | Contact department |
leadSource | string | No | — | Lead source |
description | string | No | — | Contact description |
mailingStreet | string | No | — | Mailing street address |
mailingCity | string | No | — | Mailing city |
mailingState | string | No | — | Mailing state |
mailingZip | string | No | — | Mailing ZIP code |
mailingCountry | string | No | — | Mailing country |
customFields | object | No | — | Custom field values |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"firstName": {
"type": "string",
"description": "Contact first name"
},
"lastName": {
"type": "string",
"description": "Contact last name"
},
"email": {
"type": "string",
"description": "Contact email address"
},
"phone": {
"type": "string",
"description": "Contact phone number"
},
"mobile": {
"type": "string",
"description": "Contact mobile number"
},
"accountName": {
"type": "string",
"description": "Associated account name"
},
"title": {
"type": "string",
"description": "Contact job title"
},
"department": {
"type": "string",
"description": "Contact department"
},
"leadSource": {
"type": "string",
"description": "Lead source"
},
"description": {
"type": "string",
"description": "Contact description"
},
"mailingStreet": {
"type": "string",
"description": "Mailing street address"
},
"mailingCity": {
"type": "string",
"description": "Mailing city"
},
"mailingState": {
"type": "string",
"description": "Mailing state"
},
"mailingZip": {
"type": "string",
"description": "Mailing ZIP code"
},
"mailingCountry": {
"type": "string",
"description": "Mailing country"
},
"customFields": {
"type": "object",
"additionalProperties": true,
"description": "Custom field values"
}
},
"required": [
"PCID",
"firstName",
"lastName"
]
}
Retrieve a contact by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
contactId | string | Yes | — | Contact ID to retrieve |
fields | string[] | No | — | Specific fields to retrieve |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"contactId": {
"type": "string",
"description": "Contact ID to retrieve"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specific fields to retrieve"
}
},
"required": [
"PCID",
"contactId"
]
}
Search for contacts using various criteria
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
criteria | string | Yes | — | Search criteria (e.g., “(Email:equals:john@example.com)“) |
fields | string[] | No | — | Specific fields to retrieve |
page | number | No | 1 | Page number for pagination |
perPage | number | No | 200 | Records per page (1-200) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"criteria": {
"type": "string",
"description": "Search criteria (e.g., \"(Email:equals:john@example.com)\")"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specific fields to retrieve"
},
"page": {
"type": "number",
"default": 1,
"description": "Page number for pagination"
},
"perPage": {
"type": "number",
"default": 200,
"description": "Records per page (1-200)"
}
},
"required": [
"PCID",
"criteria"
]
}
Update an existing contact
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
contactId | string | Yes | — | Contact ID to update |
firstName | string | No | — | Updated first name |
lastName | string | No | — | Updated last name |
email | string | No | — | Updated email address |
phone | string | No | — | Updated phone number |
mobile | string | No | — | Updated mobile number |
title | string | No | — | Updated job title |
department | string | No | — | Updated department |
customFields | object | No | — | Updated custom field values |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"contactId": {
"type": "string",
"description": "Contact ID to update"
},
"firstName": {
"type": "string",
"description": "Updated first name"
},
"lastName": {
"type": "string",
"description": "Updated last name"
},
"email": {
"type": "string",
"description": "Updated email address"
},
"phone": {
"type": "string",
"description": "Updated phone number"
},
"mobile": {
"type": "string",
"description": "Updated mobile number"
},
"title": {
"type": "string",
"description": "Updated job title"
},
"department": {
"type": "string",
"description": "Updated department"
},
"customFields": {
"type": "object",
"additionalProperties": true,
"description": "Updated custom field values"
}
},
"required": [
"PCID",
"contactId"
]
}
zoho_create_lead
Create a new lead in Zoho CRM
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
firstName | string | Yes | — | Lead first name |
lastName | string | Yes | — | Lead last name |
email | string | No | — | Lead email address |
phone | string | No | — | Lead phone number |
mobile | string | No | — | Lead mobile number |
company | string | No | — | Lead company |
title | string | No | — | Lead job title |
leadSource | string | No | — | Lead source |
leadStatus | string | No | — | Lead status |
industry | string | No | — | Industry |
website | string | No | — | Company website |
description | string | No | — | Lead description |
street | string | No | — | Street address |
city | string | No | — | City |
state | string | No | — | State |
zipCode | string | No | — | ZIP code |
country | string | No | — | Country |
customFields | object | No | — | Custom field values |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"firstName": {
"type": "string",
"description": "Lead first name"
},
"lastName": {
"type": "string",
"description": "Lead last name"
},
"email": {
"type": "string",
"description": "Lead email address"
},
"phone": {
"type": "string",
"description": "Lead phone number"
},
"mobile": {
"type": "string",
"description": "Lead mobile number"
},
"company": {
"type": "string",
"description": "Lead company"
},
"title": {
"type": "string",
"description": "Lead job title"
},
"leadSource": {
"type": "string",
"description": "Lead source"
},
"leadStatus": {
"type": "string",
"description": "Lead status"
},
"industry": {
"type": "string",
"description": "Industry"
},
"website": {
"type": "string",
"description": "Company website"
},
"description": {
"type": "string",
"description": "Lead description"
},
"street": {
"type": "string",
"description": "Street address"
},
"city": {
"type": "string",
"description": "City"
},
"state": {
"type": "string",
"description": "State"
},
"zipCode": {
"type": "string",
"description": "ZIP code"
},
"country": {
"type": "string",
"description": "Country"
},
"customFields": {
"type": "object",
"additionalProperties": true,
"description": "Custom field values"
}
},
"required": [
"PCID",
"firstName",
"lastName"
]
}
zoho_get_lead
Retrieve a lead by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
leadId | string | Yes | — | Lead ID to retrieve |
fields | string[] | No | — | Specific fields to retrieve |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"leadId": {
"type": "string",
"description": "Lead ID to retrieve"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specific fields to retrieve"
}
},
"required": [
"PCID",
"leadId"
]
}
zoho_convert_lead
Convert a lead to contact, account, and deal
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
leadId | string | Yes | — | Lead ID to convert |
accountName | string | No | — | Account name for conversion |
dealName | string | No | — | Deal name for conversion |
contactRole | string | No | — | Contact role after conversion |
notifyLeadOwner | boolean | No | false | Notify lead owner of conversion |
notifyNewEntityOwner | boolean | No | false | Notify new entity owner |
assignTo | string | No | — | User ID to assign converted records to |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"leadId": {
"type": "string",
"description": "Lead ID to convert"
},
"accountName": {
"type": "string",
"description": "Account name for conversion"
},
"dealName": {
"type": "string",
"description": "Deal name for conversion"
},
"contactRole": {
"type": "string",
"description": "Contact role after conversion"
},
"notifyLeadOwner": {
"type": "boolean",
"default": false,
"description": "Notify lead owner of conversion"
},
"notifyNewEntityOwner": {
"type": "boolean",
"default": false,
"description": "Notify new entity owner"
},
"assignTo": {
"type": "string",
"description": "User ID to assign converted records to"
}
},
"required": [
"PCID",
"leadId"
]
}
zoho_create_deal
Create a new deal in Zoho CRM
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
dealName | string | Yes | — | Deal name |
accountName | string | No | — | Associated account name |
contactName | string | No | — | Associated contact name |
amount | number | No | — | Deal amount |
closingDate | string | No | — | Expected closing date (YYYY-MM-DD) |
stage | string | No | — | Deal stage |
probability | number | No | — | Deal probability (0-100) |
leadSource | string | No | — | Lead source |
description | string | No | — | Deal description |
customFields | object | No | — | Custom field values |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"dealName": {
"type": "string",
"description": "Deal name"
},
"accountName": {
"type": "string",
"description": "Associated account name"
},
"contactName": {
"type": "string",
"description": "Associated contact name"
},
"amount": {
"type": "number",
"description": "Deal amount"
},
"closingDate": {
"type": "string",
"description": "Expected closing date (YYYY-MM-DD)"
},
"stage": {
"type": "string",
"description": "Deal stage"
},
"probability": {
"type": "number",
"description": "Deal probability (0-100)"
},
"leadSource": {
"type": "string",
"description": "Lead source"
},
"description": {
"type": "string",
"description": "Deal description"
},
"customFields": {
"type": "object",
"additionalProperties": true,
"description": "Custom field values"
}
},
"required": [
"PCID",
"dealName"
]
}
zoho_get_deal
Retrieve a deal by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
dealId | string | Yes | — | Deal ID to retrieve |
fields | string[] | No | — | Specific fields to retrieve |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"dealId": {
"type": "string",
"description": "Deal ID to retrieve"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specific fields to retrieve"
}
},
"required": [
"PCID",
"dealId"
]
}
zoho_update_deal
Update an existing deal
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
dealId | string | Yes | — | Deal ID to update |
dealName | string | No | — | Updated deal name |
amount | number | No | — | Updated deal amount |
closingDate | string | No | — | Updated closing date (YYYY-MM-DD) |
stage | string | No | — | Updated deal stage |
probability | number | No | — | Updated deal probability (0-100) |
description | string | No | — | Updated deal description |
customFields | object | No | — | Updated custom field values |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"dealId": {
"type": "string",
"description": "Deal ID to update"
},
"dealName": {
"type": "string",
"description": "Updated deal name"
},
"amount": {
"type": "number",
"description": "Updated deal amount"
},
"closingDate": {
"type": "string",
"description": "Updated closing date (YYYY-MM-DD)"
},
"stage": {
"type": "string",
"description": "Updated deal stage"
},
"probability": {
"type": "number",
"description": "Updated deal probability (0-100)"
},
"description": {
"type": "string",
"description": "Updated deal description"
},
"customFields": {
"type": "object",
"additionalProperties": true,
"description": "Updated custom field values"
}
},
"required": [
"PCID",
"dealId"
]
}
zoho_create_account
Create a new account in Zoho CRM
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountName | string | Yes | — | Account name |
website | string | No | — | Account website |
phone | string | No | — | Account phone number |
industry | string | No | — | Account industry |
accountType | string | No | — | Account type |
employees | number | No | — | Number of employees |
annualRevenue | number | No | — | Annual revenue |
billingStreet | string | No | — | Billing street address |
billingCity | string | No | — | Billing city |
billingState | string | No | — | Billing state |
billingCode | string | No | — | Billing ZIP code |
billingCountry | string | No | — | Billing country |
description | string | No | — | Account description |
customFields | object | No | — | Custom field values |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"accountName": {
"type": "string",
"description": "Account name"
},
"website": {
"type": "string",
"description": "Account website"
},
"phone": {
"type": "string",
"description": "Account phone number"
},
"industry": {
"type": "string",
"description": "Account industry"
},
"accountType": {
"type": "string",
"description": "Account type"
},
"employees": {
"type": "number",
"description": "Number of employees"
},
"annualRevenue": {
"type": "number",
"description": "Annual revenue"
},
"billingStreet": {
"type": "string",
"description": "Billing street address"
},
"billingCity": {
"type": "string",
"description": "Billing city"
},
"billingState": {
"type": "string",
"description": "Billing state"
},
"billingCode": {
"type": "string",
"description": "Billing ZIP code"
},
"billingCountry": {
"type": "string",
"description": "Billing country"
},
"description": {
"type": "string",
"description": "Account description"
},
"customFields": {
"type": "object",
"additionalProperties": true,
"description": "Custom field values"
}
},
"required": [
"PCID",
"accountName"
]
}
zoho_get_account
Retrieve an account by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountId | string | Yes | — | Account ID to retrieve |
fields | string[] | No | — | Specific fields to retrieve |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"accountId": {
"type": "string",
"description": "Account ID to retrieve"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specific fields to retrieve"
}
},
"required": [
"PCID",
"accountId"
]
}
zoho_create_task
Create a new task in Zoho CRM
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
subject | string | Yes | — | Task subject |
dueDate | string | Yes | — | Due date (YYYY-MM-DD) |
status | string | No | "Not Started" | Task status |
priority | string | No | "Normal" | Task priority |
whoId | string | No | — | Related contact or lead ID |
whatId | string | No | — | Related account or deal ID |
description | string | No | — | Task description |
reminderDateTime | string | No | — | Reminder date and time (YYYY-MM-DD HH:MM:SS) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"subject": {
"type": "string",
"description": "Task subject"
},
"dueDate": {
"type": "string",
"description": "Due date (YYYY-MM-DD)"
},
"status": {
"type": "string",
"enum": [
"Not Started",
"In Progress",
"Completed",
"Pending Input",
"Deferred"
],
"default": "Not Started",
"description": "Task status"
},
"priority": {
"type": "string",
"enum": [
"High",
"Highest",
"Low",
"Lowest",
"Normal"
],
"default": "Normal",
"description": "Task priority"
},
"whoId": {
"type": "string",
"description": "Related contact or lead ID"
},
"whatId": {
"type": "string",
"description": "Related account or deal ID"
},
"description": {
"type": "string",
"description": "Task description"
},
"reminderDateTime": {
"type": "string",
"description": "Reminder date and time (YYYY-MM-DD HH:MM:SS)"
}
},
"required": [
"PCID",
"subject",
"dueDate"
]
}
zoho_get_task
Retrieve a task by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
taskId | string | Yes | — | Task ID to retrieve |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"taskId": {
"type": "string",
"description": "Task ID to retrieve"
}
},
"required": [
"PCID",
"taskId"
]
}
zoho_create_note
Create a note for a record in Zoho CRM
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
noteTitle | string | Yes | — | Note title |
noteContent | string | Yes | — | Note content |
parentId | string | Yes | — | Parent record ID (contact, lead, deal, etc.) |
seModule | string | Yes | — | Module the parent record belongs to |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"noteTitle": {
"type": "string",
"description": "Note title"
},
"noteContent": {
"type": "string",
"description": "Note content"
},
"parentId": {
"type": "string",
"description": "Parent record ID (contact, lead, deal, etc.)"
},
"seModule": {
"type": "string",
"enum": [
"Contacts",
"Leads",
"Deals",
"Accounts",
"Tasks",
"Events"
],
"description": "Module the parent record belongs to"
}
},
"required": [
"PCID",
"noteTitle",
"noteContent",
"parentId",
"seModule"
]
}
zoho_search_records
Search for records across different modules
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
module | string | Yes | — | Module to search in |
criteria | string | Yes | — | Search criteria (e.g., “(Email:equals:john@example.com)“) |
fields | string[] | No | — | Specific fields to retrieve |
page | number | No | 1 | Page number for pagination |
perPage | number | No | 200 | Records per page (1-200) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"module": {
"type": "string",
"enum": [
"Contacts",
"Leads",
"Deals",
"Accounts",
"Tasks",
"Events"
],
"description": "Module to search in"
},
"criteria": {
"type": "string",
"description": "Search criteria (e.g., \"(Email:equals:john@example.com)\")"
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specific fields to retrieve"
},
"page": {
"type": "number",
"default": 1,
"description": "Page number for pagination"
},
"perPage": {
"type": "number",
"default": 200,
"description": "Records per page (1-200)"
}
},
"required": [
"PCID",
"module",
"criteria"
]
}
zoho_get_users
Get list of users in the Zoho CRM organization
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
type | string | No | "ActiveUsers" | Type of users to retrieve |
page | number | No | 1 | Page number for pagination |
perPage | number | No | 200 | Records per page (1-200) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"type": {
"type": "string",
"enum": [
"ActiveUsers",
"DeactiveUsers",
"ConfirmedUsers",
"NotConfirmedUsers",
"DeletedUsers",
"ActiveConfirmedUsers"
],
"default": "ActiveUsers",
"description": "Type of users to retrieve"
},
"page": {
"type": "number",
"default": 1,
"description": "Page number for pagination"
},
"perPage": {
"type": "number",
"default": 200,
"description": "Records per page (1-200)"
}
},
"required": [
"PCID"
]
}
zoho_get_fields
Get field metadata for a specific module
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
module | string | Yes | — | Module to get fields for |
type | string | No | "all" | Type of fields to retrieve |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"module": {
"type": "string",
"enum": [
"Contacts",
"Leads",
"Deals",
"Accounts",
"Tasks",
"Events"
],
"description": "Module to get fields for"
},
"type": {
"type": "string",
"enum": [
"all",
"unused"
],
"default": "all",
"description": "Type of fields to retrieve"
}
},
"required": [
"PCID",
"module"
]
}
zoho_create_event
Create a new event/meeting in Zoho CRM
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
eventTitle | string | Yes | — | Event title |
startDateTime | string | Yes | — | Start date and time (YYYY-MM-DD HH:MM:SS) |
endDateTime | string | Yes | — | End date and time (YYYY-MM-DD HH:MM:SS) |
location | string | No | — | Event location |
description | string | No | — | Event description |
participants | object[] | No | — | Event participants |
reminderTime | string | No | — | Reminder time before event (e.g., “15 minutes”) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"eventTitle": {
"type": "string",
"description": "Event title"
},
"startDateTime": {
"type": "string",
"description": "Start date and time (YYYY-MM-DD HH:MM:SS)"
},
"endDateTime": {
"type": "string",
"description": "End date and time (YYYY-MM-DD HH:MM:SS)"
},
"location": {
"type": "string",
"description": "Event location"
},
"description": {
"type": "string",
"description": "Event description"
},
"participants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"contact",
"lead"
],
"description": "Participant type"
},
"participant": {
"type": "string",
"description": "Participant ID"
}
}
},
"description": "Event participants"
},
"reminderTime": {
"type": "string",
"description": "Reminder time before event (e.g., \"15 minutes\")"
}
},
"required": [
"PCID",
"eventTitle",
"startDateTime",
"endDateTime"
]
}
zoho_get_event
Retrieve an event by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
eventId | string | Yes | — | Event ID to retrieve |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"eventId": {
"type": "string",
"description": "Event ID to retrieve"
}
},
"required": [
"PCID",
"eventId"
]
}