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 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 --jsonkosmokrator integrations:doctor zoho_crm --jsonkosmokrator integrations:status --json
Credentials
Authentication type: Manual OAuth tokenoauth2_manual_token. Configure credentials once, then use the same stored profile from
scripts, coding CLIs, Lua code mode, and the MCP gateway.
Key
Env var
Type
Required
Label
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.