KosmoKrator

productivity

Zoho CRM CLI for AI Agents

Use the Zoho CRM CLI from KosmoKrator to call Zoho CRM tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

15 functions 9 read 6 write Manual OAuth token auth

Zoho CRM CLI Setup

Zoho CRM can be configured headlessly with `kosmokrator integrations:configure zoho_crm`.

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure zoho_crm --set access_token="$ZOHO_CRM_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor zoho_crm --json
kosmokrator integrations:status --json

Credentials

Authentication type: Manual OAuth token oauth2_manual_token. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

KeyEnv varTypeRequiredLabel
access_token ZOHO_CRM_ACCESS_TOKEN Secret secret yes OAuth2 Access Token

Call Zoho CRM Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call zoho_crm.zoho_crm_create_lead '{
  "first_name": "example_first_name",
  "last_name": "example_last_name",
  "company": "example_company",
  "email": "example_email",
  "phone": "example_phone"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:zoho_crm zoho_crm_create_lead '{
  "first_name": "example_first_name",
  "last_name": "example_last_name",
  "company": "example_company",
  "email": "example_email",
  "phone": "example_phone"
}' --json

Agent Discovery Commands

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

kosmo integrations:docs zoho_crm --json
kosmo integrations:docs zoho_crm.zoho_crm_create_lead --json
kosmo integrations:schema zoho_crm.zoho_crm_create_lead --json
kosmo integrations:search "Zoho CRM" --json
kosmo integrations:list --json

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to Zoho CRM.

zoho_crm.zoho_crm_create_lead

Write write

Create a new lead in Zoho CRM. Provide at least a last name or company name. Other fields (first name, email, phone) are optional. Returns the created lead with its Zoho CRM ID.

Parameters
first_name, last_name, company, email, phone

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_create_lead '{"first_name":"example_first_name","last_name":"example_last_name","company":"example_company","email":"example_email","phone":"example_phone"}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_create_lead '{"first_name":"example_first_name","last_name":"example_last_name","company":"example_company","email":"example_email","phone":"example_phone"}' --json

zoho_crm.zoho_crm_get_lead

Read read

Retrieve a Zoho CRM lead by its ID. Returns the lead record with all populated fields.

Parameters
lead_id

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_get_lead '{"lead_id":"example_lead_id"}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_get_lead '{"lead_id":"example_lead_id"}' --json

zoho_crm.zoho_crm_update_lead

Write write

Update an existing lead in Zoho CRM. Provide the lead ID and the fields to update (first_name, last_name, company, email, phone). Returns the update status and modified lead details.

Parameters
lead_id, first_name, last_name, company, email, phone

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_update_lead '{"lead_id":"example_lead_id","first_name":"example_first_name","last_name":"example_last_name","company":"example_company","email":"example_email","phone":"example_phone"}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_update_lead '{"lead_id":"example_lead_id","first_name":"example_first_name","last_name":"example_last_name","company":"example_company","email":"example_email","phone":"example_phone"}' --json

zoho_crm.zoho_crm_search_leads

Read read

Search Zoho CRM leads by criteria or email. Use "criteria" for structured queries like (Email:equals:[email protected]). Use "email" as a shortcut to search by email address. Returns matching lead records.

Parameters
criteria, email

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_search_leads '{"criteria":"example_criteria","email":"example_email"}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_search_leads '{"criteria":"example_criteria","email":"example_email"}' --json

zoho_crm.zoho_crm_create_contact

Write write

Create a new contact in Zoho CRM. Provide at least a last name. Other fields (first name, email, phone) are optional. Returns the created contact with its Zoho CRM ID.

Parameters
first_name, last_name, email, phone

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_create_contact '{"first_name":"example_first_name","last_name":"example_last_name","email":"example_email","phone":"example_phone"}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_create_contact '{"first_name":"example_first_name","last_name":"example_last_name","email":"example_email","phone":"example_phone"}' --json

zoho_crm.zoho_crm_get_contact

Read read

Retrieve a Zoho CRM contact by its ID. Returns the contact record with all populated fields.

Parameters
contact_id

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_get_contact '{"contact_id":"example_contact_id"}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_get_contact '{"contact_id":"example_contact_id"}' --json

zoho_crm.zoho_crm_update_contact

Write write

Update an existing contact in Zoho CRM. Provide the contact ID and the fields to update (first_name, last_name, email, phone). Returns the update status and modified contact details.

Parameters
contact_id, first_name, last_name, email, phone

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_update_contact '{"contact_id":"example_contact_id","first_name":"example_first_name","last_name":"example_last_name","email":"example_email","phone":"example_phone"}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_update_contact '{"contact_id":"example_contact_id","first_name":"example_first_name","last_name":"example_last_name","email":"example_email","phone":"example_phone"}' --json

zoho_crm.zoho_crm_search_contacts

Read read

Search Zoho CRM contacts by criteria or email. Use "criteria" for structured queries like (Email:equals:[email protected]). Use "email" as a shortcut to search by email address. Returns matching contact records.

Parameters
criteria, email

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_search_contacts '{"criteria":"example_criteria","email":"example_email"}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_search_contacts '{"criteria":"example_criteria","email":"example_email"}' --json

zoho_crm.zoho_crm_create_account

Write write

Create a new account (organization) in Zoho CRM. Provide at least an account name. Other fields (website, phone, industry) are optional. Returns the created account with its Zoho CRM ID.

Parameters
account_name, website, phone, industry

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_create_account '{"account_name":"example_account_name","website":"example_website","phone":"example_phone","industry":"example_industry"}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_create_account '{"account_name":"example_account_name","website":"example_website","phone":"example_phone","industry":"example_industry"}' --json

zoho_crm.zoho_crm_get_account

Read read

Retrieve a Zoho CRM account by its ID. Returns the account record with all populated fields.

Parameters
account_id

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_get_account '{"account_id":"example_account_id"}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_get_account '{"account_id":"example_account_id"}' --json

zoho_crm.zoho_crm_create_deal

Write write

Create a new deal (opportunity) in Zoho CRM. Provide at least a deal name and stage. Other fields (amount, closing_date, account_id) are optional. Returns the created deal with its Zoho CRM ID.

Parameters
deal_name, amount, stage, closing_date, account_id

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_create_deal '{"deal_name":"example_deal_name","amount":1,"stage":"example_stage","closing_date":"example_closing_date","account_id":"example_account_id"}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_create_deal '{"deal_name":"example_deal_name","amount":1,"stage":"example_stage","closing_date":"example_closing_date","account_id":"example_account_id"}' --json

zoho_crm.zoho_crm_get_deal

Read read

Retrieve a Zoho CRM deal by its ID. Returns the deal record with all populated fields.

Parameters
deal_id

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_get_deal '{"deal_id":"example_deal_id"}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_get_deal '{"deal_id":"example_deal_id"}' --json

zoho_crm.zoho_crm_list_deals

Read read

List deals from Zoho CRM with optional pagination. Use page and per_page to control pagination. Returns deal records.

Parameters
page, per_page

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_list_deals '{"page":1,"per_page":1}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_list_deals '{"page":1,"per_page":1}' --json

zoho_crm.zoho_crm_list_users

Read read

List users from Zoho CRM. Optionally filter by user type (e.g. ActiveUsers, Admins) and paginate results.

Parameters
type, page

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_list_users '{"type":"example_type","page":1}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_list_users '{"type":"example_type","page":1}' --json

zoho_crm.zoho_crm_get_current_user

Read read

Retrieve the currently authenticated Zoho CRM user's profile. Returns user details including name, email, role, and other profile information.

Parameters
none

Generic CLI call

kosmo integrations:call zoho_crm.zoho_crm_get_current_user '{}' --json

Provider shortcut

kosmo integrations:zoho_crm zoho_crm_get_current_user '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

zoho_crm.zoho_crm_create_lead

Create a new lead in Zoho CRM. Provide at least a last name or company name. Other fields (first name, email, phone) are optional. Returns the created lead with its Zoho CRM ID.

Operation
Write write
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_create_lead --json
ParameterTypeRequiredDescription
first_name string no Lead first name.
last_name string no Lead last name.
company string no Lead company name.
email string no Lead email address.
phone string no Lead phone number.

zoho_crm.zoho_crm_get_lead

Retrieve a Zoho CRM lead by its ID. Returns the lead record with all populated fields.

Operation
Read read
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_get_lead --json
ParameterTypeRequiredDescription
lead_id string yes Zoho CRM lead ID.

zoho_crm.zoho_crm_update_lead

Update an existing lead in Zoho CRM. Provide the lead ID and the fields to update (first_name, last_name, company, email, phone). Returns the update status and modified lead details.

Operation
Write write
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_update_lead --json
ParameterTypeRequiredDescription
lead_id string yes Zoho CRM lead ID.
first_name string no Updated first name.
last_name string no Updated last name.
company string no Updated company name.
email string no Updated email address.
phone string no Updated phone number.

zoho_crm.zoho_crm_search_leads

Search Zoho CRM leads by criteria or email. Use "criteria" for structured queries like (Email:equals:[email protected]). Use "email" as a shortcut to search by email address. Returns matching lead records.

Operation
Read read
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_search_leads --json
ParameterTypeRequiredDescription
criteria string no Search criteria expression, e.g. (Email:equals:[email protected]).
email string no Email address to search for (shortcut for criteria).

zoho_crm.zoho_crm_create_contact

Create a new contact in Zoho CRM. Provide at least a last name. Other fields (first name, email, phone) are optional. Returns the created contact with its Zoho CRM ID.

Operation
Write write
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_create_contact --json
ParameterTypeRequiredDescription
first_name string no Contact first name.
last_name string no Contact last name.
email string no Contact email address.
phone string no Contact phone number.

zoho_crm.zoho_crm_get_contact

Retrieve a Zoho CRM contact by its ID. Returns the contact record with all populated fields.

Operation
Read read
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_get_contact --json
ParameterTypeRequiredDescription
contact_id string yes Zoho CRM contact ID.

zoho_crm.zoho_crm_update_contact

Update an existing contact in Zoho CRM. Provide the contact ID and the fields to update (first_name, last_name, email, phone). Returns the update status and modified contact details.

Operation
Write write
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_update_contact --json
ParameterTypeRequiredDescription
contact_id string yes Zoho CRM contact ID.
first_name string no Updated first name.
last_name string no Updated last name.
email string no Updated email address.
phone string no Updated phone number.

zoho_crm.zoho_crm_search_contacts

Search Zoho CRM contacts by criteria or email. Use "criteria" for structured queries like (Email:equals:[email protected]). Use "email" as a shortcut to search by email address. Returns matching contact records.

Operation
Read read
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_search_contacts --json
ParameterTypeRequiredDescription
criteria string no Search criteria expression, e.g. (Email:equals:[email protected]).
email string no Email address to search for (shortcut for criteria).

zoho_crm.zoho_crm_create_account

Create a new account (organization) in Zoho CRM. Provide at least an account name. Other fields (website, phone, industry) are optional. Returns the created account with its Zoho CRM ID.

Operation
Write write
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_create_account --json
ParameterTypeRequiredDescription
account_name string no Account (company) name.
website string no Account website URL.
phone string no Account phone number.
industry string no Industry type (e.g. Technology, Finance).

zoho_crm.zoho_crm_get_account

Retrieve a Zoho CRM account by its ID. Returns the account record with all populated fields.

Operation
Read read
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_get_account --json
ParameterTypeRequiredDescription
account_id string yes Zoho CRM account ID.

zoho_crm.zoho_crm_create_deal

Create a new deal (opportunity) in Zoho CRM. Provide at least a deal name and stage. Other fields (amount, closing_date, account_id) are optional. Returns the created deal with its Zoho CRM ID.

Operation
Write write
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_create_deal --json
ParameterTypeRequiredDescription
deal_name string no Deal name.
amount number no Deal amount.
stage string no Deal stage (e.g. Qualification, Negotiation, Closed Won).
closing_date string no Expected closing date (YYYY-MM-DD).
account_id string no Zoho CRM account ID to associate with the deal.

zoho_crm.zoho_crm_get_deal

Retrieve a Zoho CRM deal by its ID. Returns the deal record with all populated fields.

Operation
Read read
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_get_deal --json
ParameterTypeRequiredDescription
deal_id string yes Zoho CRM deal ID.

zoho_crm.zoho_crm_list_deals

List deals from Zoho CRM with optional pagination. Use page and per_page to control pagination. Returns deal records.

Operation
Read read
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_list_deals --json
ParameterTypeRequiredDescription
page integer no Page number (default 1).
per_page integer no Number of records per page (default 20, max 200).

zoho_crm.zoho_crm_list_users

List users from Zoho CRM. Optionally filter by user type (e.g. ActiveUsers, Admins) and paginate results.

Operation
Read read
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_list_users --json
ParameterTypeRequiredDescription
type string no User type filter (e.g. ActiveUsers, Admins, ActiveConfirmedAdmins).
page integer no Page number (default 1).

zoho_crm.zoho_crm_get_current_user

Retrieve the currently authenticated Zoho CRM user's profile. Returns user details including name, email, role, and other profile information.

Operation
Read read
Schema command
kosmo integrations:schema zoho_crm.zoho_crm_get_current_user --json
ParameterTypeRequiredDescription
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.