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.
Connections
Zoho OAuth 2.0 (Deprecated)
| Input | Notes | Example |
|---|---|---|
| Authorize URL | The OAuth 2.0 Authorization URL for your Zoho region | |
| Client ID | Client Identifier of your app for the Zoho API | |
| Client Secret | Client Secret of your app for the Zoho API | |
| Refresh Token Revoke URL | The OAuth 2.0 Token Revocation URL for your Zoho region | |
| Scopes | Space-separated OAuth 2.0 permission scopes for the Zoho API. Can combine Zoho CRM and Zoho Books scopes. | ZohoCRM.coql.READ ZohoCRM.notifications.ALL ZohoCRM.users.ALL ZohoCRM.org.ALL ZohoCRM.settings.ALL ZohoCRM.modules.ALL ZohoCRM.bulk.ALL ZohoBooks.fullaccess.all |
| Token URL | The OAuth 2.0 Token URL for your Zoho region |
OAuth 2.0
To make API requests of Zoho CRM or Zoho Books on behalf of your customers you need to create a Client using the Zoho Developer Console.
- Log in to the Zoho Developer Console
- Click ADD CLIENT
- Choose
Server-based Applicationsas the type of client - Fill out the Client Name and Homepage URL fields with the relevant details
- Add
https://oauth2.prismatic.io/callbackunder Authorized Redirect URIs - Note the Client ID and Client Secret values, as these will be important when using the Zoho Connection as part of your Integration
For more information please see the Zoho documentation for creating a new Client.
Zoho in Multiple Regions
Zoho offers data centers in various locations: If you develop an integration for users in a single region, you can set the Region URL to a specified region. If you plan to deploy your integration to users in multiple regions, be sure that your app is set up to support multiple data centers. Then, configure your connection's Region URL to be visible to customer deployers, so they can update those values to the region they use.
| Input | Notes | Example |
|---|---|---|
| Authorize URL | The OAuth 2.0 Authorization URL for your Zoho region | https://accounts.zoho.com/oauth/v2/auth?access_type=offline&prompt=consent |
| Client ID | Client Identifier of your app for the Zoho API | |
| Client Secret | Client Secret of your app for the Zoho API | |
| Refresh Token Revoke URL | The OAuth 2.0 Token Revocation URL for your Zoho region | https://accounts.zoho.com/oauth/v2/token/revoke |
| Scopes | Space-separated OAuth 2.0 permission scopes for the Zoho API. Can combine Zoho CRM and Zoho Books scopes. | ZohoCRM.coql.READ ZohoCRM.notifications.ALL ZohoCRM.users.ALL ZohoCRM.org.ALL ZohoCRM.settings.ALL ZohoCRM.modules.ALL ZohoCRM.bulk.ALL ZohoBooks.fullaccess.all |
| Token URL | The OAuth 2.0 Token URL for your Zoho region | https://accounts.zoho.com/oauth/v2/token |
| Region URL | The URL of the Zoho region you want to connect to. | https://accounts.zoho.com |
Actions
Books - Create Record
Create a Zoho Books Record | key: booksCreateRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Dynamic Fields | A field for dynamic inputs that can be configured at deploy time with the use of a key/value config variable. | |
| Values | The names of the fields and their values to use when creating/updating a record | |
| Parent Record Id | Id that identifies a specific parent record under which other records are grouped | 5394166000000379001 |
| Parent Record Type | The type of record to operate on | |
| Record Type | The type of record to operate on |
Books - Get Record
Get a single Zoho Books Record | key: booksGetRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Parent Record Id | Id that identifies a specific parent record under which other records are grouped | 5394166000000379001 |
| Parent Record Type | The type of record to operate on | |
| Record ID | ID that identifies a specific record | 5394166000000379001 |
| Record Type | The type of record to operate on |
Books - Get Records
Get a collection of Zoho Books Records | key: booksGetRecords
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Page | The page number to start at | 1 |
| Parent Record Id | Id that identifies a specific parent record under which other records are grouped | 5394166000000379001 |
| Parent Record Type | The type of record to operate on | |
| Per Page | The records to fetch per page | 10 |
| Record Type | The type of record to operate on | |
| Search Fields | The names and values of the fields to use for searching |
Books - Raw Request
Send raw HTTP request to Zoho Books | key: booksRawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | Enabling this flag will log out the current request. | false |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | 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. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/organizations), The base URL is already included (https://books.zoho.{api_domain}/api/v3). For example, to connect to https://books.zoho.{api_domain}/api/v3/organizations, only /organizations is entered in this field. | /organizations |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Books - Remove Record
Remove a Zoho Books Record | key: booksRemoveRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Parent Record Id | Id that identifies a specific parent record under which other records are grouped | 5394166000000379001 |
| Parent Record Type | The type of record to operate on | |
| Record ID | ID that identifies a specific record | 5394166000000379001 |
| Record Type | The type of record to operate on |
Books - Update Record
Update a Zoho Books Record | key: booksUpdateRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Dynamic Fields | A field for dynamic inputs that can be configured at deploy time with the use of a key/value config variable. | |
| Values | The names of the fields and their values to use when creating/updating a record | |
| Parent Record Id | Id that identifies a specific parent record under which other records are grouped | 5394166000000379001 |
| Parent Record Type | The type of record to operate on | |
| Record ID | ID that identifies a specific record | 5394166000000379001 |
| Record Type | The type of record to operate on |
CRM - Add attachment
Add an attachment to a Zoho CRM record (Lead, etc). | key: crmAddAttachment
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| File | The file to upload - either string contents or a binary file | |
| File Name | The name of the file to upload | |
| Record ID | ID that identifies a specific record | 5394166000000379001 |
| Record Type | Type of record to attach a file to | Leads |
CRM - COQL Query
Run a COQL Query for Zoho CRM | key: crmRunQuery
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Query | COQL Query to execute | select Last_Name from Contacts where Last_Name is not null |
CRM - Create Record
Create a Zoho CRM Record | key: crmCreateRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Dynamic Fields | A field for dynamic inputs that can be configured at deploy time with the use of a key/value config variable. | |
| Values | The names of the fields and their values to use when creating/updating a record | |
| Record Type | The type of record to operate on |
CRM - Get Record
Get a single Zoho CRM Record | key: crmGetRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Fields | The names of the fields to retrieve | |
| Record ID | ID that identifies a specific record | 5394166000000379001 |
| Record Type | The type of record to operate on |
CRM - Get Records
Get a collection of Zoho CRM Records | key: crmGetRecords
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Fields | The names of the fields to retrieve | |
| Page | The page number to start at | 1 |
| Page Token | Token used for pagination | 187d2xxxxxxc50119e |
| Per Page | The records to fetch per page | 10 |
| Record Type | The type of record to operate on | |
| Sort By | The field to sort by | |
| Sort Order | The order in which to sort the results |
CRM - Raw Request
Send raw HTTP request to Zoho CRM | key: crmRawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | Enabling this flag will log out the current request. | false |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | 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. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/Leads/1234567890/actions/convert), The base URL is already included (https://www.zohoapis.{api_domain}/crm/v3). For example, to connect to https://www.zohoapis.{api_domain}/crm/v3/Leads/1234567890/actions/convert, only /Leads/1234567890/actions/convert is entered in this field. | /Leads/1234567890/actions/convert |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
CRM - Remove Record
Remove a Zoho CRM Record | key: crmRemoveRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Record ID | ID that identifies a specific record | 5394166000000379001 |
| Record Type | The type of record to operate on |
CRM - Update Record
Update a Zoho CRM Record | key: crmUpdateRecord
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | Enabling this flag will log out the current request. | false |
| Dynamic Fields | A field for dynamic inputs that can be configured at deploy time with the use of a key/value config variable. | |
| Values | The names of the fields and their values to use when creating/updating a record | |
| Record ID | ID that identifies a specific record | 5394166000000379001 |
| Record Type | The type of record to operate on |