Can I use Zoho CRM as a CLI?

Yes. KosmoKrator exposes a Zoho CRM CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Zoho CRM through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Zoho CRM tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Zoho CRM credentials stored?

Zoho CRM credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Zoho CRM MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

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.

Zoho CRM CLI Setup

Zoho CRM can be configured headlessly with `kosmokrator integrations:configure zoho-crm`.

Install, configure, and verify

# 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 reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

Key	Env var	Type	Required	Label
`access_token`	`ZOHO_CRM_ACCESS_TOKEN`	Secret `secret`	yes	OAuth2 Access Token

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

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

Discovery

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

Discovery commands

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

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`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.

Write write

Parameters: first_name, last_name, company, email, phone

Generic 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

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`

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

Read read

Parameters: lead_id

Generic call

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

Shortcut

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

`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.

Write write

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

Generic 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

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`

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

Read read

Parameters: criteria, email

Generic call

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

Shortcut

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

`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.

Write write

Parameters: first_name, last_name, email, phone

Generic 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

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`

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

Read read

Parameters: contact_id

Generic call

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

Shortcut

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

`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.

Write write

Parameters: contact_id, first_name, last_name, email, phone

Generic 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

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`

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

Read read

Parameters: criteria, email

Generic call

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

Shortcut

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

`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.

Write write

Parameters: account_name, website, phone, industry

Generic 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

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`

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

Read read

Parameters: account_id

Generic call

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

Shortcut

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

`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.

Write write

Parameters: deal_name, amount, stage, closing_date, account_id

Generic 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

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`

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

Read read

Parameters: deal_id

Generic call

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

Shortcut

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

`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.

Read read

Parameters: page, per_page

Generic call

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

Shortcut

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

`zoho-crm.zoho_crm_list_users`

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

Read read

Parameters: type, page

Generic call

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

Shortcut

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

`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.

Read read

Parameters: none

Generic call

kosmo integrations:call zoho-crm.zoho_crm_get_current_user '{}' --json

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 5 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_create_lead --json

Parameter	Type	Required	Description
`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 1 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_get_lead --json

Parameter	Type	Required	Description
`lead_id`	string	yes	Zoho CRM lead ID.

zoho-crm.zoho_crm_update_lead 6 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_update_lead --json

Parameter	Type	Required	Description
`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 2 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_search_leads --json

Parameter	Type	Required	Description
`criteria`	string	no	Search criteria expression, e.g. (Email:equals:john@example.com).
`email`	string	no	Email address to search for (shortcut for criteria).

zoho-crm.zoho_crm_create_contact 4 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_create_contact --json

Parameter	Type	Required	Description
`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 1 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_get_contact --json

Parameter	Type	Required	Description
`contact_id`	string	yes	Zoho CRM contact ID.

zoho-crm.zoho_crm_update_contact 5 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_update_contact --json

Parameter	Type	Required	Description
`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 2 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_search_contacts --json

Parameter	Type	Required	Description
`criteria`	string	no	Search criteria expression, e.g. (Email:equals:john@example.com).
`email`	string	no	Email address to search for (shortcut for criteria).

zoho-crm.zoho_crm_create_account 4 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_create_account --json

Parameter	Type	Required	Description
`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 1 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_get_account --json

Parameter	Type	Required	Description
`account_id`	string	yes	Zoho CRM account ID.

zoho-crm.zoho_crm_create_deal 5 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_create_deal --json

Parameter	Type	Required	Description
`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 1 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_get_deal --json

Parameter	Type	Required	Description
`deal_id`	string	yes	Zoho CRM deal ID.

zoho-crm.zoho_crm_list_deals 2 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_list_deals --json

Parameter	Type	Required	Description
`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 2 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_list_users --json

Parameter	Type	Required	Description
`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 0 parameters

Schema command

kosmo integrations:schema zoho-crm.zoho_crm_get_current_user --json

Parameter	Type	Required	Description
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.