Zoho CRM connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Set up the connector

   Register your Zoho CRM credentials with Scalekit so it handles the token lifecycle. You do this once per environment.

   Dashboard setup steps

   Register your Scalekit environment with the Zoho CRM connector so Scalekit handles the authentication flow and token lifecycle for you. The connection name you create will be used to identify and invoke the connection programmatically. Then complete the configuration in your application as follows:

   1. Set up auth redirects

      • In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find Zoho CRM and click Create. Copy the redirect URI. It looks like https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback.

      • Go to Zoho API Console and click Add Client > Server-based Applications.

      • Enter a Client Name and Homepage URL. Under Authorized Redirect URIs, paste the redirect URI from Scalekit, then click Create.

        

   2. Get client credentials

      • On the app you created, go to the Client Secret tab.
      • Copy the Client ID and Client Secret. Zoho only shows the full secret once — store it securely.

   3. Match your Zoho data center Multi-DC accounts only

      Zoho hosts accounts in different regional data centers (zoho.com, zoho.eu, zoho.in, and others). If your users sign in from a data center other than the default, enable it here so their tokens resolve correctly.

      • Go to the Settings tab on your app.

      • Under Multi-DC, enable the data centers your users belong to (for example, EU (zoho.eu) or IN (zoho.in)).

        

   4. Add credentials in Scalekit

      • In the Scalekit dashboard, open the connection you created and enter:
        • Client ID (from step 2)
        • Client Secret (from step 2)
        • Scopes (see Zoho CRM OAuth scopes reference — grant only what your agent needs, for example ZohoCRM.modules.ALL)
      • Click Save.

4. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'zohocrm'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Zoho CRM:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'zohocrm_v8_accounts_list',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "zohocrm"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Zoho CRM:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="zohocrm_v8_accounts_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• List v8 users, v8 tasks, v8 tag — List users in the Zoho CRM organization, optionally filtered by user status type
• Get v8 user, v8 picklist values, v8 org — Get details for a single user in the Zoho CRM organization by user ID
• Create v8 task, v8 tag, v8 note — Create a new task in Zoho CRM
• Query v8 records — Run a SELECT-only Zoho CRM Object Query Language (COQL) query across one or more modules
• Upsert v8 record — Insert a new record or update an existing one in any Zoho CRM module, matching on the given duplicate-check fields
• Remove v8 record tags, v8 deal contact role — Remove one or more tags from a single Zoho CRM record

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

zohocrm_v8_account_create#Create a new account (company or organization) in Zoho CRM. Account_Name is required by Zoho for every account.13 params▾

Create a new account (company or organization) in Zoho CRM. Account_Name is required by Zoho for every account.

NameTypeRequiredDescription

Account_NamestringrequiredThe name of the account (company or organization)

Annual_RevenuenumberoptionalThe account's annual revenue

Billing_CitystringoptionalThe city of the account's billing address

Billing_CodestringoptionalThe postal or ZIP code of the account's billing address

Billing_CountrystringoptionalThe country of the account's billing address

Billing_StatestringoptionalThe state or province of the account's billing address

Billing_StreetstringoptionalThe street address of the account's billing address

DescriptionstringoptionalFree-form notes about the account

EmployeesintegeroptionalThe number of employees at the account

IndustrystringoptionalThe industry the account operates in

OwnershipstringoptionalThe ownership type of the account

PhonestringoptionalThe account's primary phone number

WebsitestringoptionalThe account's company website

zohocrm_v8_account_delete#Permanently delete an account from Zoho CRM by its record ID. This action cannot be undone.1 param▾

Permanently delete an account from Zoho CRM by its record ID. This action cannot be undone.

NameTypeRequiredDescription

record_idstringrequiredThe unique Zoho CRM record ID of the account to delete

zohocrm_v8_account_get#Retrieve a single account from Zoho CRM by its record ID.1 param▾

Retrieve a single account from Zoho CRM by its record ID.

NameTypeRequiredDescription

record_idstringrequiredThe unique Zoho CRM record ID of the account

zohocrm_v8_account_search#Search for accounts in Zoho CRM using Zoho's criteria syntax, with optional pagination.3 params▾

Search for accounts in Zoho CRM using Zoho's criteria syntax, with optional pagination.

NameTypeRequiredDescription

criteriastringrequiredSearch criteria in Zoho CRM criteria syntax

pageintegeroptionalPage number of results to return

per_pageintegeroptionalNumber of accounts to return per page

zohocrm_v8_account_update#Update an existing account in Zoho CRM by its record ID. Only the fields provided are changed; all other fields are left as-is.14 params▾

Update an existing account in Zoho CRM by its record ID. Only the fields provided are changed; all other fields are left as-is.

NameTypeRequiredDescription

record_idstringrequiredThe unique Zoho CRM record ID of the account to update

Account_NamestringoptionalThe name of the account (company or organization)

Annual_RevenuenumberoptionalThe account's annual revenue

Billing_CitystringoptionalThe city of the account's billing address

Billing_CodestringoptionalThe postal or ZIP code of the account's billing address

Billing_CountrystringoptionalThe country of the account's billing address

Billing_StatestringoptionalThe state or province of the account's billing address

Billing_StreetstringoptionalThe street address of the account's billing address

DescriptionstringoptionalFree-form notes about the account

EmployeesintegeroptionalThe number of employees at the account

IndustrystringoptionalThe industry the account operates in

OwnershipstringoptionalThe ownership structure of the account's company

PhonestringoptionalThe account's primary phone number

WebsitestringoptionalThe account's company website

zohocrm_v8_accounts_list#List accounts in Zoho CRM with optional field selection, sorting, and pagination.5 params▾

List accounts in Zoho CRM with optional field selection, sorting, and pagination.

NameTypeRequiredDescription

fieldsstringoptionalComma-separated list of account fields to return

pageintegeroptionalPage number of results to return

per_pageintegeroptionalNumber of accounts to return per page

sort_bystringoptionalThe field to sort results by

sort_orderstringoptionalThe sort direction

zohocrm_v8_attachment_delete#Permanently delete a file attachment from a Zoho CRM record by attachment ID.3 params▾

Permanently delete a file attachment from a Zoho CRM record by attachment ID.

NameTypeRequiredDescription

attachment_idstringrequiredID of the attachment to delete

modulestringrequiredAPI name of the Zoho CRM module the record belongs to

record_idstringrequiredID of the record the attachment belongs to

zohocrm_v8_attachment_download#Download a file attachment from a Zoho CRM record by attachment ID. Returns the raw file bytes, not a JSON payload.3 params▾

Download a file attachment from a Zoho CRM record by attachment ID. Returns the raw file bytes, not a JSON payload.

NameTypeRequiredDescription

attachment_idstringrequiredID of the attachment to download

modulestringrequiredAPI name of the Zoho CRM module the record belongs to

record_idstringrequiredID of the record the attachment belongs to

zohocrm_v8_attachment_list#List the file attachments on a single Zoho CRM record.5 params▾

List the file attachments on a single Zoho CRM record.

NameTypeRequiredDescription

modulestringrequiredAPI name of the Zoho CRM module the record belongs to

record_idstringrequiredID of the record to list attachments for

fieldsstringoptionalComma-separated list of Attachment field API names to include for each result

pagestringoptionalPage number of results to retrieve

per_pagestringoptionalNumber of attachments to return per page

zohocrm_v8_call_create#Log a new call activity in Zoho CRM. Subject is required by Zoho for every call.8 params▾

Log a new call activity in Zoho CRM. Subject is required by Zoho for every call.

NameTypeRequiredDescription

Call_DurationstringrequiredThe duration of the call

Call_Start_TimestringrequiredThe date and time the call started

Call_TypestringrequiredThe direction of the call

SubjectstringrequiredThe subject or title of the call

DescriptionstringoptionalFree-form notes about the call

Outgoing_Call_StatusstringoptionalThe outcome status of an outbound call

What_IdstringoptionalThe ID of the related record this call is about, such as a deal or account

What_ModulestringoptionalThe Zoho module the related record (What_Id) belongs to

zohocrm_v8_calls_list#List call activities from Zoho CRM. Supports selecting specific fields, pagination, and sorting.5 params▾

List call activities from Zoho CRM. Supports selecting specific fields, pagination, and sorting.

NameTypeRequiredDescription

fieldsstringoptionalComma-separated list of call field API names to return

pageintegeroptionalThe page number of results to fetch. Defaults to 1.

per_pageintegeroptionalThe number of results per page. Defaults to 200.

sort_bystringoptionalThe API name of the field to sort results by

sort_orderstringoptionalThe sort direction: asc or desc

zohocrm_v8_campaign_create#Create a new marketing campaign in Zoho CRM. Campaign_Name is required by Zoho for every campaign.9 params▾

Create a new marketing campaign in Zoho CRM. Campaign_Name is required by Zoho for every campaign.

NameTypeRequiredDescription

Campaign_NamestringrequiredThe name of the campaign

Actual_CostnumberoptionalThe actual cost incurred for the campaign

Budgeted_CostnumberoptionalThe budgeted cost for the campaign

DescriptionstringoptionalFree-form notes about the campaign

End_DatestringoptionalThe date the campaign ends

Expected_RevenuenumberoptionalThe revenue expected to be generated from the campaign

Start_DatestringoptionalThe date the campaign starts

StatusstringoptionalThe current status of the campaign

TypestringoptionalThe kind of campaign

zohocrm_v8_campaign_get#Retrieve a single marketing campaign from Zoho CRM by its record ID.1 param▾

Retrieve a single marketing campaign from Zoho CRM by its record ID.

NameTypeRequiredDescription

record_idstringrequiredThe Zoho CRM ID of the campaign to retrieve

zohocrm_v8_campaign_update#Update an existing marketing campaign in Zoho CRM. All data fields are optional; only the fields you provide are changed.10 params▾

Update an existing marketing campaign in Zoho CRM. All data fields are optional; only the fields you provide are changed.

NameTypeRequiredDescription

record_idstringrequiredThe Zoho CRM ID of the campaign to update

Actual_CostnumberoptionalThe actual cost incurred for the campaign

Budgeted_CostnumberoptionalThe budgeted cost for the campaign

Campaign_NamestringoptionalThe name of the campaign

DescriptionstringoptionalFree-form notes about the campaign

End_DatestringoptionalThe date the campaign ends

Expected_RevenuenumberoptionalThe revenue expected to be generated from the campaign

Start_DatestringoptionalThe date the campaign starts

StatusstringoptionalThe current status of the campaign

TypestringoptionalThe kind of campaign

zohocrm_v8_campaigns_list#List marketing campaigns in Zoho CRM with optional field selection, pagination, and sorting.5 params▾

List marketing campaigns in Zoho CRM with optional field selection, pagination, and sorting.

NameTypeRequiredDescription

fieldsstringoptionalComma-separated list of field API names to return for each campaign

pageintegeroptionalPage number to fetch

per_pageintegeroptionalNumber of campaigns to return per page

sort_bystringoptionalField API name to sort results by

sort_orderstringoptionalDirection to sort results

zohocrm_v8_contact_create#Create a new contact in Zoho CRM. Last_Name is required by Zoho for every contact.15 params▾

Create a new contact in Zoho CRM. Last_Name is required by Zoho for every contact.

NameTypeRequiredDescription

Last_NamestringrequiredThe contact's last name.

Account_NamestringoptionalThe name of the account (company) this contact is associated with.

DepartmentstringoptionalThe department the contact works in.

DescriptionstringoptionalFree-form notes about the contact.

EmailstringoptionalThe contact's primary email address.

First_NamestringoptionalThe contact's first name.

Lead_SourcestringoptionalWhere the contact originated from.

Mailing_CitystringoptionalThe city of the contact's mailing address.

Mailing_CountrystringoptionalThe country of the contact's mailing address.

Mailing_StatestringoptionalThe state or province of the contact's mailing address.

Mailing_StreetstringoptionalThe street address of the contact's mailing address.

Mailing_ZipstringoptionalThe postal or ZIP code of the contact's mailing address.

MobilestringoptionalThe contact's mobile phone number.

PhonestringoptionalThe contact's primary phone number.

TitlestringoptionalThe contact's job title.

zohocrm_v8_contact_delete#Permanently delete a contact from Zoho CRM by its record ID. This action cannot be undone.1 param▾

Permanently delete a contact from Zoho CRM by its record ID. This action cannot be undone.

NameTypeRequiredDescription

record_idstringrequiredThe unique Zoho CRM record ID of the contact to delete.

zohocrm_v8_contact_get#Retrieve a single contact from Zoho CRM by its record ID.1 param▾

Retrieve a single contact from Zoho CRM by its record ID.

NameTypeRequiredDescription

record_idstringrequiredThe unique Zoho CRM record ID of the contact to retrieve.

zohocrm_v8_contact_search#Search for contacts in Zoho CRM using Zoho's criteria query syntax.3 params▾

Search for contacts in Zoho CRM using Zoho's criteria query syntax.

NameTypeRequiredDescription

criteriastringrequiredSearch criteria using Zoho's query syntax: (fieldname:operator:value). Combine multiple conditions with 'and' or 'or', e.g. (Last_Name:equals:Smith)and(Email:starts_with:jane).

pageintegeroptionalThe page number of results to return.

per_pageintegeroptionalThe number of contacts to return per page.

zohocrm_v8_contact_update#Update an existing contact in Zoho CRM. All data fields are optional; only the fields provided are changed.16 params▾

Update an existing contact in Zoho CRM. All data fields are optional; only the fields provided are changed.

NameTypeRequiredDescription

record_idstringrequiredThe unique Zoho CRM record ID of the contact to update.

Account_NamestringoptionalUpdated name of the account (company) this contact is associated with.

DepartmentstringoptionalUpdated department for the contact.

DescriptionstringoptionalUpdated free-form notes about the contact.

EmailstringoptionalUpdated primary email address for the contact.

First_NamestringoptionalUpdated first name for the contact.

Last_NamestringoptionalUpdated last name for the contact.

Lead_SourcestringoptionalUpdated source the contact originated from.

Mailing_CitystringoptionalUpdated city of the contact's mailing address.

Mailing_CountrystringoptionalUpdated country of the contact's mailing address.

Mailing_StatestringoptionalUpdated state or province of the contact's mailing address.

Mailing_StreetstringoptionalUpdated street address of the contact's mailing address.

Mailing_ZipstringoptionalUpdated postal or ZIP code of the contact's mailing address.

MobilestringoptionalUpdated mobile phone number for the contact.

PhonestringoptionalUpdated primary phone number for the contact.

TitlestringoptionalUpdated job title for the contact.

zohocrm_v8_contacts_list#List contacts from Zoho CRM with optional field selection, sorting, and pagination.5 params▾

List contacts from Zoho CRM with optional field selection, sorting, and pagination.

NameTypeRequiredDescription

fieldsstringoptionalComma-separated list of field API names to return for each contact.

pageintegeroptionalThe page number of results to return.

per_pageintegeroptionalThe number of contacts to return per page.

sort_bystringoptionalThe field API name to sort results by.

sort_orderstringoptionalThe order to sort results in.

zohocrm_v8_deal_contact_role_add#Link a contact to a deal in Zoho CRM, specifying the role the contact plays such as Decision Maker or Influencer.3 params▾

Link a contact to a deal in Zoho CRM, specifying the role the contact plays such as Decision Maker or Influencer.

NameTypeRequiredDescription

contact_idstringrequiredThe ID of the contact to link to the deal

deal_idstringrequiredThe ID of the deal to add the contact role to

rolestringrequiredThe role the contact plays in the deal

zohocrm_v8_deal_contact_role_remove#Remove a contact's role association from a deal in Zoho CRM. This unlinks the contact from the deal but does not delete the contact or the deal.2 params▾

Remove a contact's role association from a deal in Zoho CRM. This unlinks the contact from the deal but does not delete the contact or the deal.

NameTypeRequiredDescription

contact_idstringrequiredThe ID of the contact to unlink from the deal

deal_idstringrequiredThe ID of the deal to remove the contact role from

zohocrm_v8_deal_contact_roles_list#List the contact roles associated with a deal in Zoho CRM. Each entry links a contact to the deal with a role name such as Decision Maker or Influencer.2 params▾

List the contact roles associated with a deal in Zoho CRM. Each entry links a contact to the deal with a role name such as Decision Maker or Influencer.

NameTypeRequiredDescription

deal_idstringrequiredThe ID of the deal whose contact roles to list

fieldsstringoptionalComma-separated list of Contact field API names to include for each linked contact

zohocrm_v8_deal_create#Create a new deal in Zoho CRM. Deal_Name and Stage are required by Zoho for every deal.11 params▾

Create a new deal in Zoho CRM. Deal_Name and Stage are required by Zoho for every deal.

NameTypeRequiredDescription

Deal_NamestringrequiredThe name of the deal

StagestringrequiredThe current stage of the deal in its sales pipeline

Account_NamestringoptionalThe name of the account (company) associated with this deal

AmountnumberoptionalThe monetary value of the deal

Closing_DatestringoptionalThe expected or actual closing date of the deal

Contact_NamestringoptionalThe record ID of the primary contact associated with this deal

DescriptionstringoptionalFree-form notes about the deal

Lead_SourcestringoptionalWhere the deal originated from

PipelinestringoptionalThe sales pipeline this deal belongs to

ProbabilityintegeroptionalThe likelihood of the deal closing, as a percentage

TypestringoptionalThe category of business this deal represents

zohocrm_v8_deal_delete#Delete a deal from Zoho CRM by its record ID. Deleted records are moved to Zoho's recycle bin rather than being purged immediately.1 param▾

Delete a deal from Zoho CRM by its record ID. Deleted records are moved to Zoho's recycle bin rather than being purged immediately.

NameTypeRequiredDescription

record_idstringrequiredThe unique identifier of the deal to delete

zohocrm_v8_deal_get#Fetch a single deal record from Zoho CRM by its record ID.1 param▾

Fetch a single deal record from Zoho CRM by its record ID.

NameTypeRequiredDescription

record_idstringrequiredThe unique identifier of the deal to fetch

zohocrm_v8_deal_search#Search for deals in Zoho CRM using Zoho's criteria query syntax.3 params▾

Search for deals in Zoho CRM using Zoho's criteria query syntax.

NameTypeRequiredDescription

criteriastringrequiredSearch criteria written in Zoho's criteria query syntax

pageintegeroptionalPage number of results to retrieve

per_pageintegeroptionalNumber of records to return per page

zohocrm_v8_deal_update#Update an existing deal in Zoho CRM by its record ID. All data fields are optional, so only the fields you provide are changed.12 params▾

Update an existing deal in Zoho CRM by its record ID. All data fields are optional, so only the fields you provide are changed.

NameTypeRequiredDescription

record_idstringrequiredThe unique identifier of the deal to update

Account_NamestringoptionalUpdated account (company) associated with this deal

AmountnumberoptionalUpdated monetary value of the deal

Closing_DatestringoptionalUpdated expected or actual closing date of the deal

Contact_NamestringoptionalUpdated record ID of the primary contact associated with this deal

Deal_NamestringoptionalUpdated name of the deal

DescriptionstringoptionalUpdated free-form notes about the deal

Lead_SourcestringoptionalUpdated source the deal originated from

PipelinestringoptionalUpdated sales pipeline this deal belongs to

ProbabilityintegeroptionalUpdated likelihood of the deal closing, as a percentage

StagestringoptionalUpdated stage of the deal in its sales pipeline

TypestringoptionalUpdated category of business this deal represents

zohocrm_v8_deals_list#List deals from Zoho CRM with optional field selection, sorting, and pagination.5 params▾

List deals from Zoho CRM with optional field selection, sorting, and pagination.

NameTypeRequiredDescription

fieldsstringoptionalComma-separated list of field API names to include in the response

pageintegeroptionalPage number of results to retrieve

per_pageintegeroptionalNumber of records to return per page

sort_bystringoptionalField API name to sort results by

sort_orderstringoptionalDirection to sort results in

zohocrm_v8_event_create#Create a new event (meeting) in Zoho CRM. Event_Title, Start_DateTime, and End_DateTime are required by Zoho for every event. Invite participants by user, contact, lead, or email so the meeting can later be cancelled with zohocrm_meeting_cancel, which requires at least one invited participant.10 params▾

Create a new event (meeting) in Zoho CRM. Event_Title, Start_DateTime, and End_DateTime are required by Zoho for every event. Invite participants by user, contact, lead, or email so the meeting can later be cancelled with zohocrm_meeting_cancel, which requires at least one invited participant.

NameTypeRequiredDescription

End_DateTimestringrequiredThe date and time the event ends, in ISO 8601 format with timezone offset

Event_TitlestringrequiredThe title of the event

Start_DateTimestringrequiredThe date and time the event starts, in ISO 8601 format with timezone offset

All_daybooleanoptionalWhether the event lasts the entire day

DescriptionstringoptionalFree-form notes about the event

participant_contact_idsstringoptionalComma-separated Zoho CRM contact IDs to invite as participants

participant_emailsstringoptionalComma-separated external email addresses to invite as participants

participant_lead_idsstringoptionalComma-separated Zoho CRM lead IDs to invite as participants

participant_user_idsstringoptionalComma-separated Zoho CRM user IDs to invite as participants

VenuestringoptionalWhere the event takes place

zohocrm_v8_event_delete#Permanently delete an event (meeting) from Zoho CRM by its record ID. This action cannot be undone.1 param▾

Permanently delete an event (meeting) from Zoho CRM by its record ID. This action cannot be undone.

NameTypeRequiredDescription

record_idstringrequiredThe Zoho CRM ID of the event to delete

zohocrm_v8_event_get#Retrieve a single event (meeting) from Zoho CRM by its record ID.1 param▾

Retrieve a single event (meeting) from Zoho CRM by its record ID.

NameTypeRequiredDescription

record_idstringrequiredThe Zoho CRM ID of the event to retrieve

zohocrm_v8_event_update#Update an existing event (meeting) in Zoho CRM. All data fields are optional; only the fields you provide are changed.7 params▾

Update an existing event (meeting) in Zoho CRM. All data fields are optional; only the fields you provide are changed.

NameTypeRequiredDescription

record_idstringrequiredThe Zoho CRM ID of the event to update

All_daybooleanoptionalWhether the event lasts the entire day

DescriptionstringoptionalFree-form notes about the event

End_DateTimestringoptionalThe date and time the event ends, in ISO 8601 format with timezone offset

Event_TitlestringoptionalThe title of the event

Start_DateTimestringoptionalThe date and time the event starts, in ISO 8601 format with timezone offset

VenuestringoptionalWhere the event takes place

zohocrm_v8_events_list#List events (meetings) in Zoho CRM with optional field selection, pagination, and sorting.5 params▾

List events (meetings) in Zoho CRM with optional field selection, pagination, and sorting.

NameTypeRequiredDescription

fieldsstringoptionalComma-separated list of field API names to return for each event

pageintegeroptionalPage number to fetch

per_pageintegeroptionalNumber of events to return per page

sort_bystringoptionalField API name to sort results by

sort_orderstringoptionalDirection to sort results

zohocrm_v8_lead_conversion_options_get#Get the existing Accounts, Contacts, and Deals that Zoho CRM would match against when converting a lead, to check for likely duplicates before converting.1 param▾

Get the existing Accounts, Contacts, and Deals that Zoho CRM would match against when converting a lead, to check for likely duplicates before converting.

NameTypeRequiredDescription

record_idstringrequiredThe unique ID of the lead record to check conversion options for

zohocrm_v8_lead_convert#Convert a qualified lead in Zoho CRM into an Account and Contact, optionally creating a Deal at the same time.8 params▾

Convert a qualified lead in Zoho CRM into an Account and Contact, optionally creating a Deal at the same time.

NameTypeRequiredDescription

record_idstringrequiredThe unique ID of the lead record to convert

create_dealbooleanoptionalWhether to also create a Deal as part of the conversion

deal_closing_datestringoptionalExpected closing date for the new Deal

deal_namestringoptionalName for the Deal created during conversion

deal_stagestringoptionalSales pipeline stage for the new Deal

notify_lead_ownerbooleanoptionalWhether to notify the lead owner after conversion

notify_new_entity_ownerbooleanoptionalWhether to notify the owner of the newly created Account, Contact, or Deal

overwritebooleanoptionalWhether to overwrite the fields of an existing matched Account or Contact with this lead's data

zohocrm_v8_lead_create#Create a new lead in Zoho CRM. Last_Name and Company are required by Zoho for every lead.12 params▾

Create a new lead in Zoho CRM. Last_Name and Company are required by Zoho for every lead.

NameTypeRequiredDescription

CompanystringrequiredThe lead's company name

Last_NamestringrequiredThe lead's last name

DescriptionstringoptionalFree-form notes about the lead

DesignationstringoptionalThe lead's job title

EmailstringoptionalThe lead's email address

First_NamestringoptionalThe lead's first name

IndustrystringoptionalThe lead's industry

Lead_SourcestringoptionalWhere the lead originated from

Lead_StatusstringoptionalCurrent qualification status of the lead

MobilestringoptionalThe lead's mobile number

PhonestringoptionalThe lead's phone number

WebsitestringoptionalThe lead's company website

zohocrm_v8_lead_delete#Permanently delete a lead from Zoho CRM by its record ID. This action cannot be undone.1 param▾

Permanently delete a lead from Zoho CRM by its record ID. This action cannot be undone.

NameTypeRequiredDescription

record_idstringrequiredThe unique ID of the lead record to delete

zohocrm_v8_lead_get#Retrieve a single lead from Zoho CRM by its record ID. Returns all standard and custom fields for the lead.1 param▾

Retrieve a single lead from Zoho CRM by its record ID. Returns all standard and custom fields for the lead.

NameTypeRequiredDescription

record_idstringrequiredThe unique ID of the lead record to retrieve

zohocrm_v8_lead_search#Search leads in Zoho CRM using Zoho's criteria syntax, matching on any combination of lead fields.3 params▾

Search leads in Zoho CRM using Zoho's criteria syntax, matching on any combination of lead fields.

NameTypeRequiredDescription

criteriastringrequiredSearch expression using Zoho's criteria syntax to match leads

pageintegeroptionalPage number of results to fetch

per_pageintegeroptionalNumber of matching lead records to return per page

zohocrm_v8_lead_update#Update an existing lead in Zoho CRM by its record ID. Only the fields provided are changed; all other fields on the lead are left as-is.13 params▾

Update an existing lead in Zoho CRM by its record ID. Only the fields provided are changed; all other fields on the lead are left as-is.

NameTypeRequiredDescription

record_idstringrequiredThe unique ID of the lead record to update

CompanystringoptionalThe lead's company name

DescriptionstringoptionalFree-form notes about the lead

DesignationstringoptionalThe lead's job title

EmailstringoptionalThe lead's email address

First_NamestringoptionalThe lead's first name

IndustrystringoptionalThe lead's industry

Last_NamestringoptionalThe lead's last name

Lead_SourcestringoptionalWhere the lead originated from

Lead_StatusstringoptionalCurrent qualification status of the lead

MobilestringoptionalThe lead's mobile number

PhonestringoptionalThe lead's phone number

WebsitestringoptionalThe lead's company website

zohocrm_v8_leads_list#List leads from Zoho CRM. Supports selecting specific fields, sorting, and pagination through large result sets.5 params▾

List leads from Zoho CRM. Supports selecting specific fields, sorting, and pagination through large result sets.

NameTypeRequiredDescription

fieldsstringoptionalComma-separated list of Lead field API names to include in each returned record

pageintegeroptionalPage number of results to fetch

per_pageintegeroptionalNumber of lead records to return per page

sort_bystringoptionalAPI name of the field to sort results by

sort_orderstringoptionalSort direction applied to sort_by

zohocrm_v8_meeting_cancel#Cancel an existing meeting (event) in Zoho CRM, optionally notifying attendees by email.2 params▾

Cancel an existing meeting (event) in Zoho CRM, optionally notifying attendees by email.

NameTypeRequiredDescription

record_idstringrequiredThe Zoho CRM ID of the meeting (event) to cancel

send_cancelling_mailbooleanoptionalWhether to notify attendees that the meeting was cancelled

zohocrm_v8_module_describe#Get metadata for a single Zoho CRM module, including its related lists, layouts, and record-conversion settings.1 param▾

Get metadata for a single Zoho CRM module, including its related lists, layouts, and record-conversion settings.

NameTypeRequiredDescription

module_api_namestringrequiredThe API name of the module to describe.

zohocrm_v8_module_fields_get#List every field defined on a Zoho CRM module, including custom fields, data types, and picklist values. Use this before creating or updating records to discover the real field API names.1 param▾

List every field defined on a Zoho CRM module, including custom fields, data types, and picklist values. Use this before creating or updating records to discover the real field API names.

NameTypeRequiredDescription

modulestringrequiredThe Zoho CRM module API name whose fields to list.

zohocrm_v8_modules_list#List every standard and custom module in the Zoho CRM org, including whether each module is creatable, editable, deletable, and API-supported.0 params▾

List every standard and custom module in the Zoho CRM org, including whether each module is creatable, editable, deletable, and API-supported.

zohocrm_v8_note_create#Attach a note to any record in Zoho CRM, such as a lead, contact, account, or deal. Note_Content is required by Zoho for every note.4 params▾

Attach a note to any record in Zoho CRM, such as a lead, contact, account, or deal. Note_Content is required by Zoho for every note.

NameTypeRequiredDescription

Note_ContentstringrequiredThe body text of the note

parent_idstringrequiredThe ID of the record to attach the note to

parent_modulestringrequiredThe API name of the module the note attaches to, e.g. Leads, Deals, Contacts, Accounts

Note_TitlestringoptionalThe title of the note

zohocrm_v8_notes_list#List the notes attached to a record in Zoho CRM, such as a lead, contact, account, or deal.5 params▾

List the notes attached to a record in Zoho CRM, such as a lead, contact, account, or deal.

NameTypeRequiredDescription

parent_idstringrequiredThe ID of the record whose notes to list

parent_modulestringrequiredThe API name of the module the notes belong to, e.g. Leads, Deals, Contacts, Accounts

fieldsstringoptionalComma-separated list of Note field API names to include in each returned record

pageintegeroptionalThe page number of results to fetch. Defaults to 1.

per_pageintegeroptionalThe number of results per page. Defaults to 200.

zohocrm_v8_org_get#Fetch details about the connected Zoho CRM organization, including company name, primary currency, time zone, and license/edition information.0 params▾

Fetch details about the connected Zoho CRM organization, including company name, primary currency, time zone, and license/edition information.

zohocrm_v8_picklist_values_get#List the configured values for a picklist field in Zoho CRM. Use zohocrm_module_fields_get first to find the field's internal ID.2 params▾

List the configured values for a picklist field in Zoho CRM. Use zohocrm_module_fields_get first to find the field's internal ID.

NameTypeRequiredDescription

field_idstringrequiredThe internal ID of the picklist field whose values to list.

modulestringrequiredThe Zoho CRM module API name that owns this field.

zohocrm_v8_record_change_owner#Reassign an existing record in any Zoho CRM module to a different owner.3 params▾

Reassign an existing record in any Zoho CRM module to a different owner.

NameTypeRequiredDescription

modulestringrequiredThe Zoho CRM module API name that contains the record.

owner_idstringrequiredThe Zoho user ID of the new record owner.

record_idstringrequiredThe unique ID of the record to reassign.

zohocrm_v8_record_clone#Create a copy of an existing record in a Zoho CRM module. Each call creates a brand-new record, even when called again with identical input.2 params▾

Create a copy of an existing record in a Zoho CRM module. Each call creates a brand-new record, even when called again with identical input.

NameTypeRequiredDescription

modulestringrequiredThe Zoho CRM module API name that contains the record to clone.

record_idstringrequiredThe unique ID of the record to clone.

zohocrm_v8_record_tags_add#Apply one or more existing tags to a single Zoho CRM record. The tags must already be defined in the module (see zohocrm_tag_create) — this does not create new tag definitions.3 params▾

Apply one or more existing tags to a single Zoho CRM record. The tags must already be defined in the module (see zohocrm_tag_create) — this does not create new tag definitions.

NameTypeRequiredDescription

modulestringrequiredAPI name of the Zoho CRM module the record belongs to

record_idstringrequiredID of the record to tag

tag_namesstringrequiredComma-separated list of existing tag names to apply to the record

zohocrm_v8_record_tags_remove#Remove one or more tags from a single Zoho CRM record. This unlinks the tags from the record only — the underlying tag definitions in the module remain intact.3 params▾

Remove one or more tags from a single Zoho CRM record. This unlinks the tags from the record only — the underlying tag definitions in the module remain intact.

NameTypeRequiredDescription

modulestringrequiredAPI name of the Zoho CRM module the record belongs to

record_idstringrequiredID of the record to remove tags from

tag_namesstringrequiredComma-separated list of existing tag names to remove from the record

zohocrm_v8_record_upsert#Insert a new record or update an existing one in any Zoho CRM module, matching on the given duplicate-check fields. Works across standard and custom modules such as Leads, Contacts, and Deals.3 params▾

Insert a new record or update an existing one in any Zoho CRM module, matching on the given duplicate-check fields. Works across standard and custom modules such as Leads, Contacts, and Deals.

NameTypeRequiredDescription

modulestringrequiredThe Zoho CRM module API name to upsert the record into.

recordobjectrequiredFree-form object of field API name to value pairs for the record to insert or update.

duplicate_check_fieldsarrayoptionalField API names Zoho uses to detect an existing matching record during the upsert.

zohocrm_v8_records_query#Run a SELECT-only Zoho CRM Object Query Language (COQL) query across one or more modules. Use this for filtering and joins that the standard list APIs cannot express.1 param▾

Run a SELECT-only Zoho CRM Object Query Language (COQL) query across one or more modules. Use this for filtering and joins that the standard list APIs cannot express.

NameTypeRequiredDescription

select_querystringrequiredFull Zoho COQL SELECT statement to execute

zohocrm_v8_related_list_get#Fetch the records in a related list for a single Zoho CRM record, e.g. all Contacts related to an Account.6 params▾

Fetch the records in a related list for a single Zoho CRM record, e.g. all Contacts related to an Account.

NameTypeRequiredDescription

modulestringrequiredAPI name of the Zoho CRM module the parent record belongs to

record_idstringrequiredID of the parent record

related_list_api_namestringrequiredAPI name of the related list to fetch

fieldsstringoptionalComma-separated list of field API names to include for each related record

pagestringoptionalPage number of results to retrieve

per_pagestringoptionalNumber of related records to return per page

zohocrm_v8_related_list_metadata_get#List the valid related-list API names for a Zoho CRM module. Custom related lists don't always match the target module's name, so look up the exact value here before calling zohocrm_related_list_get.1 param▾

List the valid related-list API names for a Zoho CRM module. Custom related lists don't always match the target module's name, so look up the exact value here before calling zohocrm_related_list_get.

NameTypeRequiredDescription

modulestringrequiredAPI name of the Zoho CRM module to fetch related list metadata for

zohocrm_v8_tag_create#Define a new tag for a Zoho CRM module. This creates the org-wide tag definition only — it does not apply the tag to any record. Use zohocrm_record_tags_add to apply an existing tag to a record.2 params▾

Define a new tag for a Zoho CRM module. This creates the org-wide tag definition only — it does not apply the tag to any record. Use zohocrm_record_tags_add to apply an existing tag to a record.

NameTypeRequiredDescription

modulestringrequiredAPI name of the Zoho CRM module to create the tag in

namestringrequiredName of the new tag to define

zohocrm_v8_tag_list#List the tags defined for a Zoho CRM module. Returns the org-wide tag definitions available for that module, not the tags applied to any specific record.1 param▾

List the tags defined for a Zoho CRM module. Returns the org-wide tag definitions available for that module, not the tags applied to any specific record.

NameTypeRequiredDescription

modulestringrequiredAPI name of the Zoho CRM module to list tags for

zohocrm_v8_task_create#Create a new task in Zoho CRM. Subject is required by Zoho for every task.7 params▾

Create a new task in Zoho CRM. Subject is required by Zoho for every task.

NameTypeRequiredDescription

SubjectstringrequiredThe subject or title of the task

DescriptionstringoptionalFree-form notes about the task

Due_DatestringoptionalThe date the task is due

PrioritystringoptionalThe priority level of the task

StatusstringoptionalThe current status of the task

What_IdstringoptionalThe ID of the related record this task is about, such as a deal or account

What_ModulestringoptionalThe Zoho module the related record (What_Id) belongs to

zohocrm_v8_tasks_list#List tasks from Zoho CRM. Supports selecting specific fields, pagination, and sorting.5 params▾

List tasks from Zoho CRM. Supports selecting specific fields, pagination, and sorting.

NameTypeRequiredDescription

fieldsstringoptionalComma-separated list of task field API names to return

pageintegeroptionalThe page number of results to fetch. Defaults to 1.

per_pageintegeroptionalThe number of results per page. Defaults to 200.

sort_bystringoptionalThe API name of the field to sort results by

sort_orderstringoptionalThe sort direction: asc or desc

zohocrm_v8_user_get#Get details for a single user in the Zoho CRM organization by user ID.1 param▾

Get details for a single user in the Zoho CRM organization by user ID.

NameTypeRequiredDescription

user_idstringrequiredID of the user to retrieve

zohocrm_v8_users_list#List users in the Zoho CRM organization, optionally filtered by user status type.3 params▾

List users in the Zoho CRM organization, optionally filtered by user status type.

NameTypeRequiredDescription

pagestringoptionalPage number of results to retrieve

per_pagestringoptionalNumber of users to return per page

typestringoptionalFilter users by status type