Zoho Crm¶

Node: zohoCrm · Full type: n8n-nodes-base.zohoCrm · Version: 1

Credentials¶

zohoOAuth2Api (alias: @zoho)

CREDENTIAL @zoho = zohoOAuth2Api "My Zoho Crm"

Operations¶

Resource: `account`¶

`create`¶

Parameter	Type	Default	Details
`accountName`	string	""	required
`additionalFields`	collection	{}	keys: `Account_Number`, `Account_Site`, `Account_Type`, `Annual_Revenue`, `Billing_Address`, `Contact_Details`, ...

`upsert`¶

Parameter	Type	Default	Details
`accountName`	string	""	required
`additionalFields`	collection	{}	keys: `Account_Number`, `Account_Site`, `Account_Type`, `Annual_Revenue`, `Billing_Address`, `Contact_Details`, ...

`delete`¶

Parameter	Type	Default	Details
`accountId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`accountId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`options`	collection	{}	keys: `approved`, `converted`, `fields`, `include_child`, `sort_by`, `sort_order`, ...

`update`¶

Parameter	Type	Default	Details
`accountId`	string	""	required
`updateFields`	collection	{}	keys: `Account_Name`, `Account_Number`, `Account_Site`, `Account_Type`, `Annual_Revenue`, `Billing_Address`, ...

Resource: `contact`¶

`create`¶

Parameter	Type	Default	Details
`lastName`	string	""	required
`additionalFields`	collection	{}	keys: `Assistant`, `customFields`, `Date_of_Birth`, `Department`, `Description`, `Email`, ...

`upsert`¶

Parameter	Type	Default	Details
`lastName`	string	""	required
`additionalFields`	collection	{}	keys: `Assistant`, `customFields`, `Date_of_Birth`, `Department`, `Description`, `Email`, ...

`delete`¶

Parameter	Type	Default	Details
`contactId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`contactId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`options`	collection	{}	keys: `approved`, `converted`, `fields`, `include_child`, `sort_by`, `sort_order`, ...

`update`¶

Parameter	Type	Default	Details
`contactId`	string	""	required
`updateFields`	collection	{}	keys: `Assistant`, `Asst_Phone`, `Currency`, `customFields`, `Date_of_Birth`, `Department`, ...

Resource: `deal`¶

`create`¶

Parameter	Type	Default	Details
`dealName`	string	""	required
`stage`	options	[]	required
`additionalFields`	collection	{}	keys: `Amount`, `Closing_Date`, `Currency`, `customFields`, `Description`, `Lead_Conversion_Time`, ...

`upsert`¶

Parameter	Type	Default	Details
`dealName`	string	""	required
`stage`	options	[]	required
`additionalFields`	collection	{}	keys: `Amount`, `Closing_Date`, `Currency`, `customFields`, `Description`, `Lead_Conversion_Time`, ...

`delete`¶

Parameter	Type	Default	Details
`dealId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`dealId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`options`	collection	{}	keys: `approved`, `converted`, `fields`, `include_child`, `sort_by`, `sort_order`, ...

`update`¶

Parameter	Type	Default	Details
`dealId`	string	""	required
`updateFields`	collection	{}	keys: `Amount`, `Closing_Date`, `Currency`, `customFields`, `Deal_Name`, `Description`, ...

Resource: `invoice`¶

`create`¶

Parameter	Type	Default	Details
`subject`	string	""	required
`Product_Details`	collection	{}	keys: `list_price`, `id`, `product_description`, `quantity`, `quantity_in_stock`, `Tax`, ...
`additionalFields`	collection	{}	keys: `accountId`, `Adjustment`, `Billing_Address`, `Currency`, `customFields`, `Description`, ...

`upsert`¶

Parameter	Type	Default	Details
`subject`	string	""	required
`Product_Details`	collection	{}	keys: `list_price`, `id`, `product_description`, `quantity`, `quantity_in_stock`, `Tax`, ...
`additionalFields`	collection	{}	keys: `accountId`, `Adjustment`, `Billing_Address`, `Currency`, `customFields`, `Description`, ...

`delete`¶

Parameter	Type	Default	Details
`invoiceId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`invoiceId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`options`	collection	{}	keys: `approved`, `converted`, `fields`, `include_child`, `sort_by`, `sort_order`, ...

`update`¶

Parameter	Type	Default	Details
`invoiceId`	string	""	required
`updateFields`	collection	{}	keys: `accountId`, `Adjustment`, `Billing_Address`, `Currency`, `customFields`, `Description`, ...

Resource: `lead`¶

`create`¶

Parameter	Type	Default	Details
`Company`	string	""	required
`lastName`	string	""	required
`additionalFields`	collection	{}	keys: `Address`, `Annual_Revenue`, `Currency`, `customFields`, `Description`, `Designation`, ...

`upsert`¶

Parameter	Type	Default	Details
`Company`	string	""	required
`lastName`	string	""	required
`additionalFields`	collection	{}	keys: `Address`, `Annual_Revenue`, `Currency`, `customFields`, `Description`, `Designation`, ...

`delete`¶

Parameter	Type	Default	Details
`leadId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`leadId`	string	""	required

`getFields`¶

No additional parameters.

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`options`	collection	{}	keys: `approved`, `converted`, `fields`, `include_child`, `sort_by`, `sort_order`, ...

`update`¶

Parameter	Type	Default	Details
`leadId`	string	""	required
`updateFields`	collection	{}	keys: `Address`, `Annual_Revenue`, `Company`, `Currency`, `customFields`, `Description`, ...

Resource: `product`¶

`create`¶

Parameter	Type	Default	Details
`productName`	string	""	required
`additionalFields`	collection	{}	keys: `Commission_Rate`, `customFields`, `Description`, `Manufacturer`, `Product_Active`, `Product_Category`, ...

`upsert`¶

Parameter	Type	Default	Details
`productName`	string	""	required
`additionalFields`	collection	{}	keys: `Commission_Rate`, `customFields`, `Description`, `Manufacturer`, `Product_Active`, `Product_Category`, ...

`delete`¶

Parameter	Type	Default	Details
`productId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`productId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`options`	collection	{}	keys: `approved`, `converted`, `fields`, `include_child`, `sort_by`, `sort_order`, ...

`update`¶

Parameter	Type	Default	Details
`productId`	string	""	required
`updateFields`	collection	{}	keys: `Commission_Rate`, `customFields`, `Description`, `Manufacturer`, `Product_Active`, `Product_Category`, ...

Resource: `purchaseOrder`¶

`create`¶

Parameter	Type	Default	Details
`subject`	string	""	required
`vendorId`	options	[]
`Product_Details`	collection	{}	keys: `list_price`, `id`, `product_description`, `quantity`, `quantity_in_stock`, `Tax`, ...
`additionalFields`	collection	{}	keys: `Adjustment`, `Billing_Address`, `Carrier`, `Currency`, `customFields`, `Description`, ...

`upsert`¶

Parameter	Type	Default	Details
`subject`	string	""	required
`vendorId`	options	[]
`Product_Details`	collection	{}	keys: `list_price`, `id`, `product_description`, `quantity`, `quantity_in_stock`, `Tax`, ...
`additionalFields`	collection	{}	keys: `Adjustment`, `Billing_Address`, `Carrier`, `Currency`, `customFields`, `Description`, ...

`delete`¶

Parameter	Type	Default	Details
`purchaseOrderId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`purchaseOrderId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`options`	collection	{}	keys: `approved`, `converted`, `fields`, `include_child`, `sort_by`, `sort_order`, ...

`update`¶

Parameter	Type	Default	Details
`purchaseOrderId`	string	""	required
`updateFields`	collection	{}	keys: `Adjustment`, `Billing_Address`, `Carrier`, `Currency`, `customFields`, `Description`, ...

Resource: `quote`¶

`create`¶

Parameter	Type	Default	Details
`subject`	string	""	required
`Product_Details`	collection	{}	keys: `list_price`, `id`, `product_description`, `quantity`, `quantity_in_stock`, `Tax`, ...
`additionalFields`	collection	{}	keys: `Adjustment`, `Billing_Address`, `Carrier`, `Currency`, `customFields`, `Description`, ...

`upsert`¶

Parameter	Type	Default	Details
`subject`	string	""	required
`Product_Details`	collection	{}	keys: `list_price`, `id`, `product_description`, `quantity`, `quantity_in_stock`, `Tax`, ...
`additionalFields`	collection	{}	keys: `Adjustment`, `Billing_Address`, `Carrier`, `Currency`, `customFields`, `Description`, ...

`delete`¶

Parameter	Type	Default	Details
`quoteId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`quoteId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`options`	collection	{}	keys: `approved`, `converted`, `fields`, `include_child`, `sort_by`, `sort_order`, ...

`update`¶

Parameter	Type	Default	Details
`quoteId`	string	""	required
`updateFields`	collection	{}	keys: `Adjustment`, `Billing_Address`, `Carrier`, `Currency`, `customFields`, `Description`, ...

Resource: `salesOrder`¶

`create`¶

Parameter	Type	Default	Details
`accountId`	options	[]	required
`subject`	string	""	required
`Product_Details`	collection	{}	keys: `list_price`, `id`, `product_description`, `quantity`, `quantity_in_stock`, `Tax`, ...
`additionalFields`	collection	{}	keys: `Adjustment`, `Billing_Address`, `Carrier`, `contactId`, `Currency`, `customFields`, ...

`upsert`¶

Parameter	Type	Default	Details
`accountId`	options	[]	required
`subject`	string	""	required
`Product_Details`	collection	{}	keys: `list_price`, `id`, `product_description`, `quantity`, `quantity_in_stock`, `Tax`, ...
`additionalFields`	collection	{}	keys: `Adjustment`, `Billing_Address`, `Carrier`, `contactId`, `Currency`, `customFields`, ...

`delete`¶

Parameter	Type	Default	Details
`salesOrderId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`salesOrderId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`options`	collection	{}	keys: `approved`, `converted`, `fields`, `include_child`, `sort_by`, `sort_order`, ...

`update`¶

Parameter	Type	Default	Details
`salesOrderId`	string	""	required
`updateFields`	collection	{}	keys: `accountId`, `Adjustment`, `Billing_Address`, `Carrier`, `contactId`, `Currency`, ...

Resource: `vendor`¶

`create`¶

Parameter	Type	Default	Details
`vendorName`	string	""	required
`additionalFields`	collection	{}	keys: `Address`, `Category`, `Currency`, `customFields`, `Description`, `Email`, ...

`upsert`¶

Parameter	Type	Default	Details
`vendorName`	string	""	required
`additionalFields`	collection	{}	keys: `Address`, `Category`, `Currency`, `customFields`, `Description`, `Email`, ...

`delete`¶

Parameter	Type	Default	Details
`vendorId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`vendorId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	5
`options`	collection	{}	keys: `approved`, `converted`, `fields`, `include_child`, `sort_by`, `sort_order`, ...

`update`¶

Parameter	Type	Default	Details
`vendorId`	string	""	required
`updateFields`	collection	{}	keys: `Address`, `Category`, `Currency`, `customFields`, `Description`, `Email`, ...

Parameter Details¶

additionalFields children:

Parameter	Type	Default	Details
`Account_Number`	string	""
`Account_Site`	string	""
`Account_Type`	options	[]
`Annual_Revenue`	number	""
`Billing_Address`	fixedCollection	{}	groups: `address_fields`
`Contact_Details`	string	""
`Currency`	options	"USD"	`USD`, `EUR`, `AED`, `AFN`, `ALL`, `ARS`, `AUD`, `AZN`, ... (87 total)
`customFields`	fixedCollection	{}	groups: `customFields`
`Description`	string	""
`Employees`	number	""
`Exchange_Rate`	number	""
`Fax`	string	""
`Industry`	string	""
`Phone`	string	""
`Shipping_Address`	fixedCollection	{}	groups: `address_fields`
`Ticker_Symbol`	string	""
`Website`	string	""

options children:

Parameter	Type	Default	Details
`approved`	boolean	true
`converted`	boolean	false
`fields`	multiOptions	[]
`include_child`	boolean	false
`sort_by`	options	[]
`sort_order`	options	"desc"	`asc`, `desc`
`territory_id`	string	""

updateFields children:

Parameter	Type	Default	Details
`Account_Name`	string	""
`Account_Number`	string	""
`Account_Site`	string	""
`Account_Type`	options	[]
`Annual_Revenue`	number	""
`Billing_Address`	fixedCollection	{}	groups: `address_fields`
`Contact_Details`	string	""
`Currency`	options	"USD"	`USD`, `EUR`, `AED`, `AFN`, `ALL`, `ARS`, `AUD`, `AZN`, ... (87 total)
`customFields`	fixedCollection	{}	groups: `customFields`
`Description`	string	""
`Employees`	number	""
`Exchange_Rate`	number	""
`Fax`	string	""
`Industry`	string	""
`Phone`	string	""
`Shipping_Address`	fixedCollection	{}	groups: `address_fields`
`Ticker_Symbol`	string	""
`Website`	string	""

Product_Details children:

Parameter	Type	Default
`list_price`	number	""
`id`	options	[]
`product_description`	string	""
`quantity`	number	1
`quantity_in_stock`	number	0
`Tax`	number	0
`total`	number	0
`total_after_discount`	number	0
`net_total`	number	0
`unit_price`	number	0

Example¶

NODE "zohoCrm" @zoho AS "Zoho Crm" {
  resource: "account",
  operation: "get",
  accountName: {{ $json.accountName }},
  accountId: {{ $json.accountId }},
  lastName: {{ $json.lastName }}
}

Zoho Crm¶

Credentials¶

Operations¶

Resource: account¶

create¶

upsert¶

delete¶

get¶

getAll¶

update¶

Resource: contact¶

create¶

upsert¶

delete¶

get¶

getAll¶

update¶

Resource: deal¶

create¶

upsert¶

delete¶

get¶

getAll¶

update¶

Resource: invoice¶

create¶

upsert¶

delete¶

get¶

getAll¶

update¶

Resource: lead¶

create¶

upsert¶

delete¶

get¶

getFields¶

getAll¶

update¶

Resource: product¶

create¶

upsert¶

delete¶

get¶

getAll¶

update¶

Resource: purchaseOrder¶

create¶

upsert¶

delete¶

get¶

getAll¶

update¶

Resource: quote¶

create¶

upsert¶

delete¶

get¶

getAll¶

update¶

Resource: salesOrder¶

create¶

upsert¶

delete¶

get¶

getAll¶

update¶

Resource: vendor¶

create¶

upsert¶

delete¶

get¶

getAll¶

update¶

Parameter Details¶

Example¶

Resource: `account`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `contact`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `deal`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `invoice`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `lead`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getFields`¶

`getAll`¶

`update`¶

Resource: `product`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `purchaseOrder`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `quote`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `salesOrder`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `vendor`¶

`create`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶