Skip to main content

Zoho Component

Manage records, users, and more in your Zoho CRM and Books apps

Component key: zoho

Description#

Zoho CRM acts as a single repository to bring your sales, marketing, and customer support activities together, and streamline your process, policy, and people in one platform. Zoho Books is your one-stop platform for managing your accounting tasks and organizing your transactions. It's a single secure location to keep up with your company's bills and invoices, reconcile your bank statements, control your spending, oversee projects, and eliminate sales tax compliance worries.

Zoho Connections#

Zoho OAuth 2.0#

InputDefaultNotes
Input
Authorize URL
string
/ Required
Default
https://accounts.zoho.com/oauth/v2/auth?
Notes
The OAuth 2.0 Authorization URL for the API. Differs per Zoho region. Default: https://accounts.zoho.com/oauth/v2/auth?
Input
Client ID
string
/ Required
Default
Notes
Client Identifier of your app for the Zoho API
Input
Client Secret
password
/ Required
Default
Notes
Client Secret of your app for the Zoho API
Input
Refresh Token Revoke URL
string
Default
https://accounts.zoho.com/oauth/v2/token/revoke
Notes
URL to revoke Zoho refresh tokens. Differs per region.
Input
Scopes
string
/ Required
Default
ZohoCRM.coql.READ ZohoCRM.notifications.ALL ZohoCRM.users.ALL ZohoCRM.org.ALL ZohoCRM.settings.ALL ZohoCRM.modules.ALL ZohoCRM.bulk.ALL ZohoBooks.fullaccess.all
Notes
Space separated OAuth 2.0 permission scopes for the Zoho API. Can combine Zoho CRM and Zoho Books scopes.
Input
Token URL
string
/ Required
Default
https://accounts.zoho.com/oauth/v2/token
Notes
The OAuth 2.0 Token URL for the API. Differs per Zoho region. Default: https://accounts.zoho.com/oauth/v2/token

Actions#

Books - Create Record#

Create a Zoho Books Record | key: booksCreateRecord

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
Dynamic Fields
data
Default
Notes
A field for dynamic inputs that can be configured at deploy time with the use of a key/value config variable.
Example
 
Input
Values
string
Key Value List
Default
Notes
The names of the fields and their values to use when creating/updating a record
Example
 
Input
Parent Record Id
string
Default
Notes
Id that identifies a specific parent record under which other records are grouped
Example
5394166000000379001
Input
Parent Record Type
string
Default
Notes
The type of record to operate on
Example
 
Input
Record Type
string
/ Required
Default
Notes
The type of record to operate on
Example
 

Books - Get Record#

Get a single Zoho Books Record | key: booksGetRecord

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
Parent Record Id
string
Default
Notes
Id that identifies a specific parent record under which other records are grouped
Example
5394166000000379001
Input
Parent Record Type
string
Default
Notes
The type of record to operate on
Example
 
Input
Record Id
string
/ Required
Default
Notes
Id that identifies a specific record
Example
5394166000000379001
Input
Record Type
string
/ Required
Default
Notes
The type of record to operate on
Example
 

Books - Get Records#

Get a collection of Zoho Books Records | key: booksGetRecords

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
Page
string
Default
Notes
The page number to start at
Example
1
Input
Parent Record Id
string
Default
Notes
Id that identifies a specific parent record under which other records are grouped
Example
5394166000000379001
Input
Parent Record Type
string
Default
Notes
The type of record to operate on
Example
 
Input
Per Page
string
Default
200
Notes
The records to fetch per page
Example
10
Input
Record Type
string
/ Required
Default
Notes
The type of record to operate on
Example
 
Input
Search Fields
string
Key Value List
Default
Notes
The names and values of the fields to use for searching
Example
 

Books - Raw Request#

Send Raw Request to Zoho Books | key: booksRawRequest

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Data
string
Default
Notes
The HTTP body payload to send to the URL.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
Default
Notes
File Data to be sent as a multipart form upload.
Example
[{key: "example.txt", value: "My File Contents"}]
Input
Form Data
string
Key Value List
Default
Notes
The Form Data to be sent as a multipart form upload.
Example
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Input
Header
string
Key Value List
Default
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Method
string
/ Required
Default
Notes
The HTTP method to use.
Example
 
Input
Query Parameter
string
Key Value List
Default
Notes
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Example
 
Input
Response Type
string
/ Required
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Timeout
string
Default
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
Notes
This is the URL to call.
Example
/sobjects/Account
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Books - Remove Record#

Remove a Zoho Books Record | key: booksRemoveRecord

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
Parent Record Id
string
Default
Notes
Id that identifies a specific parent record under which other records are grouped
Example
5394166000000379001
Input
Parent Record Type
string
Default
Notes
The type of record to operate on
Example
 
Input
Record Id
string
/ Required
Default
Notes
Id that identifies a specific record
Example
5394166000000379001
Input
Record Type
string
/ Required
Default
Notes
The type of record to operate on
Example
 

Books - Update Record#

Update a Zoho Books Record | key: booksUpdateRecord

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
Dynamic Fields
data
Default
Notes
A field for dynamic inputs that can be configured at deploy time with the use of a key/value config variable.
Example
 
Input
Values
string
Key Value List
Default
Notes
The names of the fields and their values to use when creating/updating a record
Example
 
Input
Parent Record Id
string
Default
Notes
Id that identifies a specific parent record under which other records are grouped
Example
5394166000000379001
Input
Parent Record Type
string
Default
Notes
The type of record to operate on
Example
 
Input
Record Id
string
/ Required
Default
Notes
Id that identifies a specific record
Example
5394166000000379001
Input
Record Type
string
/ Required
Default
Notes
The type of record to operate on
Example
 

CRM - COQL Query#

Run a COQL Query for Zoho CRM | key: crmRunQuery

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
Query
text
/ Required
Default
Notes
COQL Query to execute
Example
select Last_Name from Contacts where Last_Name is not null

CRM - Create Record#

Create a Zoho CRM Record | key: crmCreateRecord

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Input
Dynamic Fields
data
Default
Notes
A field for dynamic inputs that can be configured at deploy time with the use of a key/value config variable.
Input
Values
string
Key Value List
Default
Notes
The names of the fields and their values to use when creating/updating a record
Input
Record Type
string
/ Required
Default
Notes
The type of record to operate on

CRM - Get Record#

Get a single Zoho CRM Record | key: crmGetRecord

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
Fields
string
Value List
Default
Notes
The names of the fields to retrieve
Example
 
Input
Record Id
string
/ Required
Default
Notes
Id that identifies a specific record
Example
5394166000000379001
Input
Record Type
string
/ Required
Default
Notes
The type of record to operate on
Example
 

CRM - Get Records#

Get a collection of Zoho CRM Records | key: crmGetRecords

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
Fields
string
/ Required
Value List
Default
Notes
The names of the fields to retrieve
Example
 
Input
Page
string
Default
Notes
The page number to start at
Example
1
Input
Page Token
string
Default
Notes
Token used for pagination
Example
187d2xxxxxxc50119e
Input
Per Page
string
Default
200
Notes
The records to fetch per page
Example
10
Input
Record Type
string
/ Required
Default
Notes
The type of record to operate on
Example
 
Input
Sort By
string
Default
Notes
The field to sort by
Example
 
Input
Sort Order
string
Default
Notes
The order in which to sort the results
Example
 

CRM - Raw Request#

Send Raw Request to Zoho CRM | key: crmRawRequest

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Data
string
Default
Notes
The HTTP body payload to send to the URL.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
Default
Notes
File Data to be sent as a multipart form upload.
Example
[{key: "example.txt", value: "My File Contents"}]
Input
Form Data
string
Key Value List
Default
Notes
The Form Data to be sent as a multipart form upload.
Example
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Input
Header
string
Key Value List
Default
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Method
string
/ Required
Default
Notes
The HTTP method to use.
Example
 
Input
Query Parameter
string
Key Value List
Default
Notes
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Example
 
Input
Response Type
string
/ Required
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Timeout
string
Default
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
Notes
This is the URL to call.
Example
/sobjects/Account
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

CRM - Remove Record#

Remove a Zoho CRM Record | key: crmRemoveRecord

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
Record Id
string
/ Required
Default
Notes
Id that identifies a specific record
Example
5394166000000379001
Input
Record Type
string
/ Required
Default
Notes
The type of record to operate on
Example
 

CRM - Update Record#

Update a Zoho CRM Record | key: crmUpdateRecord

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
Dynamic Fields
data
Default
Notes
A field for dynamic inputs that can be configured at deploy time with the use of a key/value config variable.
Example
 
Input
Values
string
Key Value List
Default
Notes
The names of the fields and their values to use when creating/updating a record
Example
 
Input
Record Id
string
/ Required
Default
Notes
Id that identifies a specific record
Example
5394166000000379001
Input
Record Type
string
/ Required
Default
Notes
The type of record to operate on
Example