Zoho CRM

welcome to the zoho crm guide, your go to resource for connecting and automating your business processes! this guide will walk you through setting up a connection, managing records and streamline your workflows with ease getting started with zoho prerequisites create / sign in to your zoho crm account https //www zoho com/signup html make sure you have permission to create oauth applications create oauth credentials ( client id and client secret ) by following the official zoho guide zoho oauth client registration guide https //www zoho com/developer/oauth/register app html connecting engini to zoho enter your engini account at https //app engini io https //app engini io/ navigate to connections page by clicking on the connections on the left sidebar or by clicking here https //app engini io/connections click on the "new integration" option located at the top bar choose zoho crm option from the available applications enter the following details in the “new integration” form and press save note there are two different authentication methods available, and the required fields differ depending on the option you choose please follow the relevant instructions based on your selected method oauth2 this method uses a predefined authentication flow you simply sign in using your account connection name enter unique identifier for the connection within engini authentication method select oauth2 signin click on the “signin” button sign into your account save click on the save button to save the connection custom this method requires you to configure your own oauth2 credentials you must provide both a valid client id and client secret obtained from your zoho crm account connection name – choose a unique identifier for the connection within engini authentication method – select custom oauth2 client id – enter the client id from the oauth 2 0 credentials client secret – enter the client secret from the same set of oauth 2 0 credentials scopes leave the default value to grant full access, or specify custom permissions as needed signin – click signin and log in with the zoho account this ensures access to the correct oauth credentials and permissions save click on the save button to save the connection triggers check for created records triggers the workflow whenever new records are created in zoho crm based on a scheduled check module selects the specific zoho crm entity you want to monitor for newly created entries starting (utc) select the start date and time for the scheduled trigger recur every choose the time interval for triggering add frame time you can specify a time frame during which the trigger will operate for example, every 15 minutes from 8 am to 5 pm top n specifies the maximum number of entries to retrieve, with a default setting of all entries if left blank add sort click add sort to organize the data list by a selected field in ascending or descending order to learn more about sorting data, click here https //help engini ai/workflow editor#add sorts add conditions click add conditions to define conditions that narrow down the data list and return only the relevant items to learn more about using conditions, click here https //help engini ai/workflow editor#add conditions check for updated records triggers the workflow whenever existing records are updated in zoho crm based on a scheduled check module selects the specific zoho crm entity you want to monitor for modifications or edits starting (utc) the exact date and time benchmark from which the workflow starts looking for modified records recur every choose the time interval for triggering add frame time you can specify a time frame during which the trigger will operate for example, every 15 minutes from 8 am to 5 pm top n specifies the maximum number of entries to retrieve, with a default setting of all entries if left blank actions get users retrieves a list of users from your zoho crm account with optional filtering user category filters the user retrieval request based on user type classification in zoho crm click the select item dropdown to choose a category add filter click to add specific criteria to narrow down and refine the list of retrieved users get user retrieves detailed information for a specific user in zoho crm by their user id user id enter the target user id directly or map dynamic data from a previous step for example from create record to retrieve that user's full details like email, role, or phone number get fields retrieves the list of available fields and their metadata for a selected module in zoho crm api name of the module enter the api name of the module get list of modules retrieves a list of all supported standard and custom modules available in your zoho crm account get records retrieves a list of records from a selected zoho crm module with optional filtering, sorting, and pagination object type select the target zoho crm module from which you want to fetch records click the dropdown and select your target module (e g , leads, contacts, deals, or accounts) top n specifies the maximum number of records to retrieve in a single execution leave blank to retrieve all matching records (default=all) offset specify the number of items to skip before starting the retrieval this is useful for pagination the default is 0 (no items skipped) add filter click add filter to define conditions that narrow down the data list and return only the relevant items to learn more about using filters, click here https //help engini ai/workflow editor#add filters add sort click add sort to organize the data list by a selected field in ascending or descending order to learn more about sorting data, click here https //help engini ai/workflow editor#add sorts get record retrieves detailed information for a specific record in a selected zoho crm module using its record id object type select the specific zoho crm module from which you want to fetch a single record click the dropdown and select your target module (e g , leads, contacts, deals, or accounts) record id enter a static record id or map it dynamically from a previous workflow step (e g , mapping the id field from a search or trigger payload, such as 7306588000000807001) get roles retrieves a list of all defined user roles and their hierarchy from your zoho crm account get profiles retrieves a list of all user profiles and their permission settings from your zoho crm account get list of attachments retrieves a list of file attachments associated with a specific record in zoho crm module select the specific zoho crm module (entity) that contains the record with the target attachments click the dropdown and select the relevant module (e g , leads, contacts, deals, or accounts) record id enter a static record id or map it dynamically from a preceding step top n leave blank to retrieve all attachments associated with the record (default=all), or specify an integer (e g , 5 or 10) to restrict the total returned payload size add user creates a new user in your zoho crm account with assigned roles and profiles first name enter the user's first name email enter a valid email address zoho crm will send an account invitation link to this address role define the user's position in the role hierarchy (e g , ceo, sales manager, sales rep), it will control the data visibility across your organization profile determine the exact module level permissions and feature access the user will have (e g , administrator, standard, or a custom permission profile) create record creates a new record in a selected zoho crm module with specified field values once an object type is selected, engini dynamically loads all relevant standard and custom fields for that specific module choose the target module (e g , leads, contacts, deals, or accounts) fill out all required fields, along with any optional fields you'd like to include download a photo downloads the photo attached to a specific record or user profile in zoho crm module click the dropdown and select the relevant module (e g , leads, contacts, deals, or accounts) record id enter a record id from which you want to download a photo upload photo uploads a photo to a specific record or user profile in zoho crm module click the dropdown and select the relevant module (e g , leads, contacts, deals, or accounts) record id enter a record id, where the photo will be uploaded filename enter the full filename (e g , profile picture png or avatar2 jpg) or map it dynamically from a previous file handling step content enter the payload or raw image data encoded as a base64 upload an attachment uploads a file attachment to a specific record in zoho crm module click the dropdown and select the relevant module (e g , leads, contacts, deals, or accounts) record id enter a record id, where the attachment will be uploaded filename enter the full filename (e g , contract pdf) or map it dynamically from a previous file handling step content provide the file contents as a base64 encoded payload update user updates the details and settings of an existing user in zoho crm user id enter a static user id or map it dynamically from a previous step (e g , mapping the id field from a "get users" step) update record updates the field values of an existing record in a selected zoho crm module object type select the target zoho crm module containing the record you wish to modify record id enter or map the unique identification number of the specific record you want to update fill or map values into only the specific fields you want to update according to the object you chose delete record/records deletes one or more records from a selected zoho crm module using their record ids object type select the target zoho crm module containing the records you want to delete record ids provide a single record id or a comma separated list of ids to delete multiple records at once delete user deletes a specified user from your zoho crm account using their user id user id enter the unique identification number of the specific user account you want to delete from zoho crm delete a photo deletes the photo attached to a specific record or user profile in zoho crm module select the specific zoho crm module containing the record whose photo you want to delete record id enter or map the unique identification number of the specific crm record associated with the photo initialize object array creates a new variable object in your workflow to store structured data for use in subsequent zoho steps variable name enter a unique name for the array variable that will store the collection of objects throughout the workflow object element type select the type of object to store in the array, which will then open its fields so you can fill in the values for the first object add field click to select and populate specific fields for the first object entry in the array append to object array adds new data elements to an existing array of objects in your workflow variable select the existing object array variable to which you want to append a new object entry add field click to select and populate specific fields for the new object being added to the array map object array this activity is particularly useful when there is an array of data that needs to be translated into another structure data list select or map the source array/list of data items you want to iterate over and transform object name select the target object type or schema structure that each item in the data list should be mapped to add field click to select and map specific fields from the source data to the corresponding target object fields send api request the “send api request” action allows you to send custom http requests to an api endpoint this can be used to perform a wide range of operations, such as creating, updating, or deleting resources, fetching data, or triggering specific actions base url – this is the root url of the api you’re sending the request to relative url – you can specify additional path segments or parameters that need to be added to the end of the automatically generated url this allows you to customize the specific request you want to perform method – select the http method (e g , get, post, put, delete, patch) body type – defines the format of the data in the body of your request commonly used values include application/json (as shown), which means the body will contain a json formatted payload body – contains any data that is being sent to the server add headers – additional metadata about the request, such as the type of data the engini can accept, the length of the request body, and authentication information add queries – the query refers to the parameters or data that are included in the url of an http request to provide additional information or instructions to the server