Skip to main content

Zoho Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Zoho location.
zoho_api.png

Zoho

Create a Zoho Destination​

  1. Click the + icon on the Nexset that will be sent to the Zoho destination, and select the Send to Destination option from the menu.

  2. Select the Zoho connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Zoho instance, and click Next; or, create a new Zoho credential for use in this flow.

  3. In Nexla, Zoho destinations can be created using pre-built endpoint templates, which expedite destination setup for common Zoho endpoints. Each template is designed specifically for the corresponding Zoho endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

Zoho destinations can also be configured manually, allowing you to send data to Zoho endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
• To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Zoho endpoints. Each template is designed specifically for the corresponding Zoho endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Add or Update Accounts

    This endpoint template inserts or updates accounts in your Zoho CRM account. If the account does not exist, Zoho inserts the account as new. If the account already exists, it is updated based on duplicate checks. Use this template when you need to automatically create or update accounts based on data from your Nexla flows.

    • This endpoint sends data as JSON in the request body to insert or update accounts. Each record from your Nexset will be sent as a separate API request to upsert an account. The request body should contain the account data in the format required by the Zoho CRM API, including all required fields for account creation or update.

    This endpoint sends data as JSON in the request body to insert or update accounts in your Zoho CRM account. If the account does not exist, Zoho inserts the account as new. If the account already exists, it is updated based on duplicate checks. The request body should contain the account data in the format required by the Zoho CRM API, including all required fields for account creation or update.

    The account structure must match the Zoho CRM API's expected format. Ensure your account data includes all required fields. For detailed information about account upsert operations, request body formats, and available account properties, see the Zoho CRM API documentation.

    Add or Update Leads

    This endpoint template inserts or updates leads in your Zoho CRM account. If the lead does not exist, Zoho inserts the lead as new. If the lead already exists, it is updated based on duplicate checks. Use this template when you need to automatically create or update leads based on data from your Nexla flows.

    • This endpoint sends data as JSON in the request body to insert or update leads. Each record from your Nexset will be sent as a separate API request to upsert a lead. The request body should contain the lead data in the format required by the Zoho CRM API, including all required fields for lead creation or update.

    This endpoint sends data as JSON in the request body to insert or update leads in your Zoho CRM account. If the lead does not exist, Zoho inserts the lead as new. If the lead already exists, it is updated based on duplicate checks. The request body should contain the lead data in the format required by the Zoho CRM API, including all required fields for lead creation or update.

    The lead structure must match the Zoho CRM API's expected format. Ensure your lead data includes all required fields. For detailed information about lead upsert operations, request body formats, and available lead properties, see the Zoho CRM API documentation.

    Add or Update Contacts

    This endpoint template inserts or updates contacts in your Zoho CRM account. If the contact does not exist, Zoho inserts the contact as new. If the contact already exists, it is updated based on duplicate checks. Use this template when you need to automatically create or update contacts based on data from your Nexla flows.

    • This endpoint sends data as JSON in the request body to insert or update contacts. Each record from your Nexset will be sent as a separate API request to upsert a contact. The request body should contain the contact data in the format required by the Zoho CRM API, including all required fields for contact creation or update.

    This endpoint sends data as JSON in the request body to insert or update contacts in your Zoho CRM account. If the contact does not exist, Zoho inserts the contact as new. If the contact already exists, it is updated based on duplicate checks. The request body should contain the contact data in the format required by the Zoho CRM API, including all required fields for contact creation or update.

    The contact structure must match the Zoho CRM API's expected format. Ensure your contact data includes all required fields. For detailed information about contact upsert operations, request body formats, and available contact properties, see the Zoho CRM API documentation.

    Add or Update Cases

    This endpoint template inserts or updates cases in your Zoho CRM account. If the case does not exist, Zoho inserts the case as new. If the case already exists, then Zoho updates the record based on duplicate checks. Use this template when you need to automatically create or update cases based on data from your Nexla flows.

    • This endpoint sends data as JSON in the request body to insert or update cases. Each record from your Nexset will be sent as a separate API request to upsert a case. The request body should contain the case data in the format required by the Zoho CRM API, including all required fields for case creation or update.

    This endpoint sends data as JSON in the request body to insert or update cases in your Zoho CRM account. If the case does not exist, Zoho inserts the case as new. If the case already exists, then Zoho updates the record based on duplicate checks. The request body should contain the case data in the format required by the Zoho CRM API, including all required fields for case creation or update.

    The case structure must match the Zoho CRM API's expected format. Ensure your case data includes all required fields. For detailed information about case upsert operations, request body formats, and available case properties, see the Zoho CRM API documentation.

    Add or Update Invoices

    This endpoint template inserts or updates invoices in your Zoho CRM account. If the invoice does not exist, Zoho inserts the record as new. If the invoice already exists, then Zoho updates the record based on duplicate checks. Use this template when you need to automatically create or update invoices based on data from your Nexla flows.

    • This endpoint sends data as JSON in the request body to insert or update invoices. Each record from your Nexset will be sent as a separate API request to upsert an invoice. The request body should contain the invoice data in the format required by the Zoho CRM API, including all required fields for invoice creation or update.

    This endpoint sends data as JSON in the request body to insert or update invoices in your Zoho CRM account. If the invoice does not exist, Zoho inserts the record as new. If the invoice already exists, then Zoho updates the record based on duplicate checks. The request body should contain the invoice data in the format required by the Zoho CRM API, including all required fields for invoice creation or update.

    The invoice structure must match the Zoho CRM API's expected format. Ensure your invoice data includes all required fields. For detailed information about invoice upsert operations, request body formats, and available invoice properties, see the Zoho CRM API documentation.

Configure Manually​

Zoho destinations can be manually configured to send data to any valid Zoho CRM API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Zoho CRM API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Zoho CRM API from the Method pulldown menu. The most common methods for Zoho destinations are:

    • POST: For creating new resources or upserting records (most common for Zoho destinations)
    • PUT: For updating existing resources
    • PATCH: For partial updates to existing resources

Data Format​

  1. Select the format in which the Nexset data will be sent to the Zoho CRM API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call.

The Zoho CRM APIs typically expect JSON format for most operations. Choose JSON unless you have specific requirements for other formats.

API Endpoint URL​

  1. Enter the URL of the Zoho CRM API endpoint to which you want to send the Nexset data in the URL field. For upsert operations, the URL typically follows the pattern {api_domain}/crm/v2/{module_name}/upsert where {api_domain} is your Zoho API domain (e.g., https://www.zohoapis.com) and {module_name} is the module name (e.g., Accounts, Leads, Contacts). For create operations, use {api_domain}/crm/v2/{module_name}. For update operations, include the ID of the object to be updated at the end of the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires OAuth 2.0 authentication via the Authorization header, which is handled automatically by your credential configuration.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Zoho destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings—click on an algorithm listed below to view instructions for configuring these settings.

Record batching is particularly useful for Zoho destinations when you need to process large numbers of records efficiently. Batching can help reduce API calls and improve performance.

Response Webhook​

Optional

Nexla can automatically send the response received from the Zoho CRM API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Response webhooks are particularly useful for Zoho destinations to track record creation/update status, upsert confirmations, and any error responses from the Zoho CRM API.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Zoho CRM API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.
  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Zoho CRM API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Zoho CRM API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Zoho endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to the Zoho endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.