{ "opencollection": "1.0.0", "info": { "name": "Helpcenter Settings API", "version": "1.0.0" }, "items": [ { "info": { "name": "Settings", "type": "folder" }, "items": [ { "info": { "name": "Get Duplicate Check Preference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/duplicate_check_preference", "params": [ { "name": "module", "value": "", "type": "query", "description": "The API name of the module for which to manage duplicate check preferences. Example: Leads" } ] }, "docs": "Get Duplicate Check Preference" }, { "info": { "name": "Create Duplicate Check Preference", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/duplicate_check_preference", "params": [ { "name": "module", "value": "", "type": "query", "description": "The API name of the module for which to manage duplicate check preferences. Example: Leads" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Duplicate Check Preference" }, { "info": { "name": "Update Duplicate Check Preference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/duplicate_check_preference", "params": [ { "name": "module", "value": "", "type": "query", "description": "The API name of the module for which to manage duplicate check preferences. Example: Leads" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Duplicate Check Preference API is used to update duplicate check settings for a specific module in the CRM system. It allows users to define how duplicate records are identified and managed based on field mappings between the current module and a mapped module, such as Contacts. This API helps maintain data integrity by preventing the creation of duplicate records during data entry or import processes." }, { "info": { "name": "Delete Duplicate Check Preference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/duplicate_check_preference", "params": [ { "name": "module", "value": "", "type": "query", "description": "The API name of the module for which to manage duplicate check preferences. Example: Leads" } ] }, "docs": "Delete the duplicate check preference for a module in Zoho CRM." }, { "info": { "name": "Get all global picklists", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/global_picklists", "params": [ { "name": "include", "value": "", "type": "query", "description": "Comma-separated list of related resources to include. Allowed values: \"used_in_modules\", \"pick_list_values\", \"associated_fields_count\". Use CSV encoding (style=form, explode=false) for multiple values, e.g. include=used_in_modules,pick_list_values." }, { "name": "include_inner_details", "value": "", "type": "query", "description": "Optional detailed expansion keys. Currently only allowed when `used_in_modules` is present in `include`. Allowed value: used_in_modules.plural_label." } ] }, "docs": "Fetches the list of global picklists available in the organization along with their details. pick_list_values, used_in_modules, and associated_fields_count can be included in the response based on the 'include' query parameter. A 204 is returned when no global picklists exist." }, { "info": { "name": "Create a new global picklist", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/global_picklists", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new global picklist with the specified display label, API name, description, and picklist values. The actual_label, customizable, modified_by, created_by, and presence properties are generated by the backend. In pick_list_values, only display_value and type are considered." }, { "info": { "name": "Get a single global picklist by id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/global_picklists/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Numeric id of the resource." }, { "name": "include", "value": "", "type": "query", "description": "Comma-separated list of related resources to include. Allowed values: \"used_in_modules\", \"pick_list_values\", \"associated_fields_count\". Use CSV encoding (style=form, explode=false) for multiple values, e.g. include=used_in_modules,pick_list_values." }, { "name": "include_inner_details", "value": "", "type": "query", "description": "Optional detailed expansion keys. Currently only allowed when `used_in_modules` is present in `include`. Allowed value: used_in_modules.plural_label." } ] }, "docs": "Fetches the global picklist for given id along with their pick_list_values. used_in_modules, and associated_fields_count can be included in the response based on the 'include' query parameter. A 204 is returned when no global picklists exist." }, { "info": { "name": "Update a global picklist by id", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/settings/global_picklists/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Numeric id of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing global picklist identified by the path parameter \\{id\\}. You can update display_label, api_name, description, pick_list_values_sorted_lexically, and pick_list_values. Backend-generated properties (actual_label, customizable, modified_by, created_by, presence) cannot be updated. For pick_list_values, you can add new values, update existing values (using id), move values between used/unused (one at a time), or delete values (one at a time using _delete: true). Bulk operations f" }, { "info": { "name": "Delete a global picklist by id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/global_picklists/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Numeric id of the resource." } ] }, "docs": "Deletes a single global picklist identified by the path parameter \\{id\\}. This request is asynchronous: a 202 Accepted indicates deletion has been scheduled and the response contains a job_id in details. There is no status-check endpoint. A 400 Bad Request is returned for invalid id, deletion already scheduled, conversion in progress, association limits, or system-defined restrictions. When an error refers to a position in a multi-resource request/path, details.resource_path_index is provided." }, { "info": { "name": "Get picklist value associations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/global_picklists/:id/actions/pick_list_values_associations", "params": [ { "name": "id", "value": "", "type": "path", "description": "Numeric id of the resource." }, { "name": "picklist_value_id", "value": "", "type": "query", "description": "The ID of the picklist value to retrieve associations for." } ] }, "docs": "To the list of features like blueprints, workflows create, workflow convert, workflow task, ABM, etc in which a particular picklist value is used." }, { "info": { "name": "Get Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/user_groups", "params": [ { "name": "filters", "value": "", "type": "query", "description": "Filter criteria for user groups" }, { "name": "include", "value": "", "type": "query", "description": "Additional data to include in the response" }, { "name": "page", "value": "", "type": "query", "description": "Page number to retrieve" }, { "name": "per_page", "value": "", "type": "query", "description": "Number of items to return per page" } ] }, "docs": "Get the list of user groups available in your organization." }, { "info": { "name": "Create Group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/user_groups", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new user group in your organization." }, { "info": { "name": "Get Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/user_groups/:group", "params": [ { "name": "group", "value": "", "type": "path", "description": "The unique identifier of the user group" } ] }, "docs": "Get details of the specified user group." }, { "info": { "name": "Update Group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/user_groups/:group", "params": [ { "name": "group", "value": "", "type": "path", "description": "The unique identifier of the user group" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing user group in your organization." }, { "info": { "name": "Delete Group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/user_groups/:group", "params": [ { "name": "group", "value": "", "type": "path", "description": "The unique identifier of the user group" } ] }, "docs": "Delete an existing user group from your organization." }, { "info": { "name": "Get Sources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/user_groups/:group/sources", "params": [ { "name": "group", "value": "", "type": "path", "description": "The unique identifier of the user group" }, { "name": "page", "value": "", "type": "query", "description": "Page number to retrieve" }, { "name": "per_page", "value": "", "type": "query", "description": "Number of items to return per page" } ] }, "docs": "Get the list of members for the specified user group." }, { "info": { "name": "Get Sources Count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/user_groups/:group/actions/sources_count", "params": [ { "name": "group", "value": "", "type": "path", "description": "The unique identifier of the user group" } ] }, "docs": "Get the count of sources (territories, roles, groups, and users) for the specified user group." }, { "info": { "name": "Get Associated Users Count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/user_groups/actions/associated_users_count", "params": [ { "name": "filters", "value": "", "type": "query", "description": "Filter criteria for user groups" }, { "name": "page", "value": "", "type": "query", "description": "Page number to retrieve" }, { "name": "per_page", "value": "", "type": "query", "description": "Number of items to return per page" } ] }, "docs": "Get the count of users associated with user groups based on the provided filters." }, { "info": { "name": "Get Group associations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/user_groups/:group/actions/associations", "params": [ { "name": "group", "value": "", "type": "path", "description": "The unique identifier of the user group" } ] }, "docs": "You can associate a user group with sharing rules, workflows, assignment rules, approval and review processes, and email notification criteria. Use this API to find out where a user group is associated." }, { "info": { "name": "Get all roles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/roles" }, "docs": "Retrieve a list of all CRM roles in the organization" }, { "info": { "name": "Create new roles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/roles", "body": { "type": "json", "data": "{}" } }, "docs": "Create one or more new CRM roles in the organization" }, { "info": { "name": "Update multiple roles", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/roles", "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple CRM roles in the organization" }, { "info": { "name": "Get specific role", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/roles/:role", "params": [ { "name": "role", "value": "", "type": "path", "description": "Role identifier" } ] }, "docs": "Retrieve details of a specific CRM role by its identifier" }, { "info": { "name": "Update role", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/roles/:role", "params": [ { "name": "role", "value": "", "type": "path", "description": "The unique identifier of the role" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing CRM role with new information" }, { "info": { "name": "Delete role", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/roles/:role", "params": [ { "name": "role", "value": "", "type": "path", "description": "The unique identifier of the role" }, { "name": "transfer_to_id", "value": "", "type": "query", "description": "The ID of the role to transfer child roles to when deleting a role" } ] }, "docs": "Delete an existing CRM role and transfer users to another role" }, { "info": { "name": "GET /settings/variable_groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/variable_groups" }, "docs": "To get the list variable groups created in crm org" }, { "info": { "name": "PUT variable_groups", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/variable_groups", "body": { "type": "json", "data": "{}" } }, "docs": "Update variable group details" }, { "info": { "name": "GET variable_groups by {id}", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/variable_groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "variable groups id in url path" } ] }, "docs": "To get the particular variable group" }, { "info": { "name": "PUT by variable_groups by id", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/variable_groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "variable groups id in url path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update variable group details" }, { "info": { "name": "List portal user types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/portals/:portal/user_type", "params": [ { "name": "portal", "value": "", "type": "path", "description": "Portal unique name (path parameter). Provide the portal identifier as defined in the account." } ] }, "docs": "Retrieve all user types for the specified portal." }, { "info": { "name": "Create portal user type", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/portals/:portal/user_type", "params": [ { "name": "portal", "value": "", "type": "path", "description": "Portal unique name (path parameter). Provide the portal identifier as defined in the account." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create one or more portal user types for the specified portal. Request body must include a user_type array with one or more user type objects." }, { "info": { "name": "Get portal user type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/portals/:portal/user_type/:userTypeId", "params": [ { "name": "portal", "value": "", "type": "path", "description": "Portal unique name (path parameter). Provide the portal identifier as defined in the account." }, { "name": "userTypeId", "value": "", "type": "path", "description": "Unique id of the portal user type. Represented as a long numeric id encoded as a string." } ] }, "docs": "Retrieve details for the specified portal user type." }, { "info": { "name": "Update portal user type", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/portals/:portal/user_type/:userTypeId", "params": [ { "name": "portal", "value": "", "type": "path", "description": "Portal unique name (path parameter). Provide the portal identifier as defined in the account." }, { "name": "userTypeId", "value": "", "type": "path", "description": "Unique id of the portal user type. Represented as a long numeric id encoded as a string." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the specified portal user type. Request body must include user_type array with items containing the fields to update." }, { "info": { "name": "Delete portal user type", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/portals/:portal/user_type/:userTypeId", "params": [ { "name": "portal", "value": "", "type": "path", "description": "Portal unique name (path parameter). Provide the portal identifier as defined in the account." }, { "name": "userTypeId", "value": "", "type": "path", "description": "Unique id of the portal user type. Represented as a long numeric id encoded as a string." } ] }, "docs": "Delete the specified portal user type." }, { "info": { "name": "Retrieve email templates list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/email_templates", "params": [ { "name": "module", "value": "", "type": "query", "description": "Module API name for filtering" }, { "name": "sort_by", "value": "", "type": "query", "description": "Field name to sort by" }, { "name": "sort_order", "value": "", "type": "query", "description": "Sort order (ascending or descending)" }, { "name": "category", "value": "", "type": "query", "description": "Template category filter. Note: Allowed values are favorite | created_by_me | shared_with_me | associated | draft." }, { "name": "filters", "value": "", "type": "query", "description": "JSON-stringified filter expression. See operation description for supported comparators and group_operator." }, { "name": "per_page", "value": "", "type": "query", "description": "Number of items per page (default = 20, max = 100)" }, { "name": "page", "value": "", "type": "query", "description": "Page number, starting at 1" } ] }, "docs": "Fetches a paginated list of email templates with support for filtering, sorting, and pagination. Use page/per_page for pagination (default per_page=20, max=100), sort_by and sort_order for sorting, and filters parameter for advanced filtering." }, { "info": { "name": "GET /settings/automation/webhooks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/webhooks", "params": [ { "name": "module", "value": "", "type": "query", "description": "Represents the parent module that the webhook monitors" }, { "name": "page", "value": "", "type": "query", "description": "To get the list of webhooks from the respective pages. The default value is 1. Note that you cannot use this param with the \"page_token\" param." }, { "name": "per_page", "value": "", "type": "query", "description": "Specify how many webhooks to return per page. The default and the maximum possible value is 200." }, { "name": "sort_by", "value": "", "type": "query", "description": "To sort the webhooks based on the Modified_Time field." }, { "name": "sort_order", "value": "", "type": "query", "description": "To sort the available list of webhooks in either ascending or descending order, based on the value of sort_by parameter." }, { "name": "feature_type", "value": "", "type": "query", "description": "o filter webhooks by their automation feature type. Possible values: workflow , assignmentrules , connectedworkflow" }, { "name": "related_module", "value": "", "type": "query", "description": "To filter webhooks triggered by a child or dependent module linked to a parent module. For example, the webhook will be triggered whenever a note (child) is created under a lead (Parent)." }, { "name": "filters", "value": "", "type": "query", "description": "This parameter allows you to filter the webhooks available in your organization by their name." } ] }, "docs": "Retrieve all available webhooks configured in your Zoho CRM account." }, { "info": { "name": "POST /settings/automation/webhooks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/automation/webhooks", "body": { "type": "json", "data": "{}" } }, "docs": "Webhooks in Zoho CRM allow you to send real-time data from Zoho CRM to external applications or services when specific events occur such as Record creation, update, or deletion." }, { "info": { "name": "PUT /settings/automation/webhooks", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/automation/webhooks", "body": { "type": "json", "data": "{}" } }, "docs": "To update an existing webhook available in your Zoho CRM account." }, { "info": { "name": "DELETE /settings/automation/webhooks", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/automation/webhooks", "params": [ { "name": "ids", "value": "", "type": "query", "description": "pecify the webhook IDs that need to be deleted. Use the Get Webhooks API to retrieve all available webhook IDs. A maximum of 10 webhooks can be deleted in a single API call." } ] }, "docs": "To delete one or more webhooks configured in your Zoho CRM account. You can delete up to 10 webhooks in a single API call." }, { "info": { "name": "GET /settings/automation/webhooks/{webhookId}", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "The ID of the webhook to retrieve." } ] }, "docs": "Retrieve the webhooks configured in your Zoho CRM account." }, { "info": { "name": "PUT /settings/automation/webhooks", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/automation/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "The ID of the webhook to retrieve." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update an existing webhook available in your Zoho CRM account." }, { "info": { "name": "DELETE /settings/automation/webhooks/{webhookId}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/automation/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "The ID of the webhook to delete." } ] }, "docs": "To delete one webhooks configured in your Zoho CRM account." }, { "info": { "name": "GET /settings/automation/webhook_failures", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/webhook_failures", "params": [ { "name": "webhook_id", "value": "", "type": "query", "description": "The unique ID of the webhook whose failure details you want to retrieve." }, { "name": "module", "value": "", "type": "query", "description": "Represents the parent module that the webhook monitors" }, { "name": "from", "value": "", "type": "query", "description": "The start date in YYYY-MM-DD format, from which webhook failure details are to be fetched.. " }, { "name": "to", "value": "", "type": "query", "description": "The end date in YYYY-MM-DD format, up to which failure records are to be retrieved." }, { "name": "page", "value": "", "type": "query", "description": "To get the list of webhooks from the respective pages. The default value is 1. Note that you cannot use this param with the \"page_token\" param." }, { "name": "per_page", "value": "", "type": "query", "description": "Specify how many webhooks to return per page. The default and the maximum possible value is 200." } ] }, "docs": "To retrieve detailed information about webhook execution failures in your Zoho CRM organization." }, { "info": { "name": "GET /settings/automation/webhooks/actions/associated_modules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/webhooks/actions/associated_modules" }, "docs": "To retrieve the list of modules that are associated with Webhook actions in the current CRM account." }, { "info": { "name": "GET /settings/automation/webhooks/actions/usage_reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/webhooks/actions/usage_reports", "params": [ { "name": "group_by", "value": "", "type": "query", "description": "Specify the criteria to group the usage data. Please note that date is mandatory, and you can optionally include other values separated by commas." }, { "name": "type", "value": "", "type": "query", "description": "Specify the type of resource to filter or group the usage data. This parameter is mandatory when resource is included in the group_by value." }, { "name": "from", "value": "", "type": "query", "description": "The start date in YYYY-MM-DD format, from which webhook failure details are to be fetched.. " }, { "name": "to", "value": "", "type": "query", "description": "The end date in YYYY-MM-DD format, up to which failure records are to be retrieved." }, { "name": "page", "value": "", "type": "query", "description": "To get the list of webhooks from the respective pages. The default value is 1. Note that you cannot use this param with the \"page_token\" param." }, { "name": "per_page", "value": "", "type": "query", "description": "Specify how many webhooks to return per page. The default and the maximum possible value is 200." } ] }, "docs": "To retrieve usage statistics for Webhook actions executed in Zoho CRM over the last seven days. " }, { "info": { "name": "Retrieve related lists configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/related_lists", "params": [ { "name": "module", "value": "", "type": "query", "description": "API name of the CRM module (e.g., Leads, Contacts, Accounts)" }, { "name": "layout_id", "value": "", "type": "query", "description": "Unique identifier of the layout for which to retrieve related lists" }, { "name": "status", "value": "", "type": "query", "description": "Filter related lists by visibility status" } ] }, "docs": "Get the configuration of related lists for a specific module and layout" }, { "info": { "name": "Retrieve business hours configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/business_hours" }, "docs": "Retrieves the current business hours configuration including working days, hours, and timezone." }, { "info": { "name": "Create business hours configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/business_hours", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new business hours configuration specifying working days, hours, and timezone for the organization." }, { "info": { "name": "Update business hours configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/business_hours", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the existing business hours configuration with new working days, hours, or timezone settings." }, { "info": { "name": "Get All WorkflowRules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/workflow_rules", "params": [ { "name": "page", "value": "", "type": "query", "description": "To get the list of Workflow from a specific page" }, { "name": "per_page", "value": "", "type": "query", "description": "To fetch a limited number of Workflow rules per page" }, { "name": "module", "value": "", "type": "query", "description": "The module for which the rule counts should be provided." }, { "name": "status_active", "value": "", "type": "query", "description": "To filter the Workflow rules based on whether they are active or inactive" }, { "name": "execute_on", "value": "", "type": "query", "description": "To filter the Workflow rules based on the record action that triggers them" }, { "name": "sort_order", "value": "", "type": "query", "description": "To sort the Workflow rules in ascending or descending order, based on the modified_field value" }, { "name": "sort_by", "value": "", "type": "query", "description": "To sort the Workflow rules based on a specific field." }, { "name": "include_inner_details", "value": "", "type": "query", "description": "To include the inner details of the Workflow rules in the response" }, { "name": "filter", "value": "", "type": "query", "description": "To filter the Workflow rules by their name" } ] }, "docs": "To retrieve the list of Workflow rules" }, { "info": { "name": "Configure a Workflow rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/automation/workflow_rules", "body": { "type": "json", "data": "{}" } }, "docs": "To configure a Workflow rule" }, { "info": { "name": "Update Workflow Rule For the Given ID in Body", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/automation/workflow_rules", "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing workflow rule with partial data." }, { "info": { "name": "Delete Multiple Workflow Rules", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/automation/workflow_rules", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Unique IDs of Workflow rule(s). Pass up to ten Workflow rule IDs, in a comma separated format." } ] }, "docs": "Delete Multiple Workflow Rules" }, { "info": { "name": "Retrieve a single workflow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/workflow_rules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Single ID of a workflow rule." } ] }, "docs": "To retrieve the details of a specific Workflow rule in your Zoho CRM account." }, { "info": { "name": "Update Workflow Rule By ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/automation/workflow_rules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Single ID of a workflow rule." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing workflow rule with partial data." }, { "info": { "name": "Delete Workflow Rule By ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/automation/workflow_rules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Single ID of a workflow rule." } ] }, "docs": "Deletes an existing workflow rule by its ID." }, { "info": { "name": "Get Workflow Rule actions count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/workflow_rules/actions/actions_count", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Unique IDs of Workflow rule(s). Pass up to ten Workflow rule IDs, in a comma separated format." } ] }, "docs": "To retrieve the total number of actions configured in the specified Workflow rules, including both instant and scheduled actions. The response includes a count of actions, categorized by action type." }, { "info": { "name": "Get Workflow Rule actions count for each module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/workflow_rules/actions/module_specific_count", "params": [ { "name": "module", "value": "", "type": "query", "description": "The module for which the rule counts should be provided." } ] }, "docs": "Get Workflow Rule actions count for each module" }, { "info": { "name": "Get Workflow Rules count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/workflow_rules/actions/rules_count" }, "docs": "To fetch the limit and usage details of workflow rules and actions in your Zoho CRM account. Use this API to track how many rules and actions are configured and how many more you can create." }, { "info": { "name": "To retrieve Workflow Rule usage", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/workflow_rules/:workflowRuleId/actions/usage", "params": [ { "name": "executed_from", "value": "", "type": "query", "description": "Start date for fetching usage data in ISO 8601 format (yyyy-mm-dd)." }, { "name": "executed_till", "value": "", "type": "query", "description": "The end date for fetching usage data in ISO 8601 format (yyyy-mm-dd). " }, { "name": "workflowRuleId", "value": "", "type": "path", "description": "Path parameter: workflow_rule_ID" } ] }, "docs": "To retrieve the usage report of a specific Workflow Rule in your Zoho CRM organization. It provides a count of how many times the workflow was triggered and the success or failure metrics for each associated action within a specified date range." }, { "info": { "name": "To reorder workflow rules", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/automation/workflow_rules/actions/reorder", "params": [ { "name": "module", "value": "", "type": "query", "description": "The module for which the rule counts should be provided." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update the execution order of Workflow rules in a specific module in Zoho CRM. By default, workflow rules are executed in the order in which they are created." }, { "info": { "name": "GET /settings/automation/tasks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/tasks", "params": [ { "name": "feature_type", "value": "", "type": "query", "description": "To retrieve tasks based on their feature type." }, { "name": "module", "value": "", "type": "query", "description": "To retrieve tasks based on their module." }, { "name": "per_page", "value": "", "type": "query", "description": "Specify how many tasks to return per page. The default and the maximum possible value is 200." }, { "name": "page", "value": "", "type": "query", "description": "To get the list of tasks from the respective pages. The default value is 1. Possible values: Positive integer values only." } ] }, "docs": "To retrieve the list of automation tasks configured in your Zoho CRM organization." }, { "info": { "name": "POST /settings/automation/tasks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/automation/tasks", "body": { "type": "json", "data": "{}" } }, "docs": "To create an automation task in your Zoho CRM organization." }, { "info": { "name": "DELETE /settings/automation/tasks", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/automation/tasks", "params": [ { "name": "ids", "value": "", "type": "query", "description": "It represents the unique ID of the task that you want to delete. Skip this parameter if you have specified the ID in the request URL. You can pass upto 10 comma-separated IDs in this parameter." } ] }, "docs": "To delete automation tasks configured in your Zoho CRM account." }, { "info": { "name": "GET /settings/automation/tasks/{id}", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/tasks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the task to retrieve" }, { "name": "include_inner_details", "value": "", "type": "query", "description": "data needed" } ] }, "docs": "To retrieve automation tasks configured in your Zoho CRM organization" }, { "info": { "name": "PUT /settings/automation/tasks/123445566", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/automation/tasks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the task to retrieve" } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update an automation task in your Zoho CRM organization." }, { "info": { "name": "DELETE /settings/automation/tasks/{id}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/automation/tasks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the task to retrieve" } ] }, "docs": "To delete automation tasks configured in your Zoho CRM account." }, { "info": { "name": "List recycle bin records", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/recycle_bin" }, "docs": "Returns paginated recycle-bin entries. Use filters or ids to scope results." }, { "info": { "name": "Delete multiple recycle bin records", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/recycle_bin", "params": [ { "name": "filters", "value": "", "type": "query", "description": "Filter expression to scope records. For complex filters use the POST /actions/restore requestBody `filters` object instead; this query param typically accepts a simple criteria string or encoded expression." } ] }, "docs": "Permanently deletes matching recycle-bin records. This is a destructive operation and may partially succeed for some items; check 207 responses for per-item results." }, { "info": { "name": "Restore multiple recycle bin records", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/recycle_bin/actions/restore", "body": { "type": "json", "data": "{}" } }, "docs": "Restores multiple recycle-bin records based on provided criteria. You can specify records to restore using one of: `ids`, `filters`, or `restore_all_records`. Only one of these fields should be provided; supplying multiple will result in an error. When the number of records to restore (including child records) exceeds 1000, the operation is scheduled as a background job (202 status). For 1000 or fewer records, restoration happens immediately (200/207 status)." }, { "info": { "name": "Get recycle bin counts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/recycle_bin/actions/count" }, "docs": "Returns the count of items in the recycle bin. Useful for monitoring or quick summaries." }, { "info": { "name": "Empty the recycle bin", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/recycle_bin/actions/empty" }, "docs": "Permanently deletes all records from the Recycle Bin. This action is irreversible, as deleted records cannot be restored after this operation. When the number of records in the Recycle Bin exceeds 1000 (including child records), the deletion will be scheduled as a background job (202 status). If the count is 1000 or fewer, the records are deleted immediately (200 status). Only users with the Admin profile can empty the Recycle Bin." }, { "info": { "name": "Restore a recycle bin record", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/recycle_bin/:recordId/actions/restore", "params": [ { "name": "recordId", "value": "", "type": "path", "description": "Identifier of the recycle-bin record. Format depends on CRM configuration (e.g., numeric or UUID)." } ] }, "docs": "Restores a single recycle-bin record identified by the path parameter `record_id`." }, { "info": { "name": "Get a recycle bin record", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/recycle_bin/:recordId", "params": [ { "name": "recordId", "value": "", "type": "path", "description": "Identifier of the recycle-bin record to retrieve." } ] }, "docs": "Returns a single recycle-bin record identified by the path parameter `record_id`. The record_id in the URL takes precedence over any filters or ids given in query parameters." }, { "info": { "name": "Delete a recycle bin record", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/recycle_bin/:recordId", "params": [ { "name": "recordId", "value": "", "type": "path", "description": "Identifier of the recycle-bin record to delete." } ] }, "docs": "Permanently deletes the recycle-bin record identified by `record_id`. This is irreversible." }, { "info": { "name": "Retrieve service preference settings for the organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/service_preferences" }, "docs": "Fetch service preference configuration for the organization." }, { "info": { "name": "Update service preference settings for the organization", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/service_preferences", "body": { "type": "json", "data": "{}" } }, "docs": "Update the service preference configuration for the organization." }, { "info": { "name": "GET /settings/automation/scoring_rules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/scoring_rules", "params": [ { "name": "module", "value": "", "type": "query", "description": "api_name of the module" }, { "name": "layout_id", "value": "", "type": "query", "description": "layout id" }, { "name": "page", "value": "", "type": "query", "description": "current batch of rules" }, { "name": "per_page", "value": "", "type": "query", "description": "no of rules per request" }, { "name": "name", "value": "", "type": "query", "description": "Scoring rule name" }, { "name": "include_inner_details", "value": "", "type": "query", "description": "Child rule details can be fetched using this param" } ] }, "docs": "Returns the list of scoring rules configured. If params are passed, rules matched the param value will be returned." }, { "info": { "name": "POST /settings/automation/scoring_rules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/automation/scoring_rules", "body": { "type": "json", "data": "{}" } }, "docs": "Configure scoring rules for a module and layout." }, { "info": { "name": "PUT /settings/automation/scoring_rules", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/automation/scoring_rules", "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple scoring rules" }, { "info": { "name": "DELETE /settings/automation/scoring_rules", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/automation/scoring_rules", "params": [ { "name": "ids", "value": "", "type": "query", "description": "rule ids in comma separated format" } ] }, "docs": "To delete multiple scoring rules" }, { "info": { "name": "GET /settings/automation/scoring_rules/{ruleId}", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/scoring_rules/:ruleId", "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "Path parameter: ruleId" } ] }, "docs": "Returns the scoring rule details" }, { "info": { "name": "PUT /settings/automation/scoring_rules/{ruleId}", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/automation/scoring_rules/:ruleId", "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "Path parameter: ruleId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update a scoring rule name, description, field_rules, touch_point_rules or custom_fields." }, { "info": { "name": "DELETE /settings/automation/scoring_rules/{ruleId}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/automation/scoring_rules/:ruleId", "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "Path parameter: ruleId" } ] }, "docs": "To delete a single scoring rule" }, { "info": { "name": "PUT /settings/automation/scoring_rules/{ruleId}/actions/activate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/automation/scoring_rules/:ruleId/actions/activate", "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "Path parameter: ruleId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "To activate the scoring rule" }, { "info": { "name": "DELETE /settings/automation/scoring_rules/{ruleId}/actions/activate", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/automation/scoring_rules/:ruleId/actions/activate", "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "Path parameter: ruleId" } ] }, "docs": "To deactivate a scoring rule" }, { "info": { "name": "POST /settings/automation/scoring_rules/{ruleId}/actions/clone", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/automation/scoring_rules/:ruleId/actions/clone", "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "Path parameter: ruleId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "To clone the scoring rule" }, { "info": { "name": "Activate layout with profile associations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/layouts/:id/actions/activate", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the layout to activate or deactivate. Must be a valid layout ID that exists within the specified module. Layout ID values are data center-specific." }, { "name": "module", "value": "", "type": "query", "description": "The CRM module API name that contains the layout. Supports both standard Zoho CRM modules (e.g., Leads, Contacts, Deals) and custom modules created in the organization. Module names follow PascalCase convention and may contain underscores for custom modules." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Activates a single deactivated layout, making it available for use within the specified module. Optionally allows adding or removing profile associations during activation. Only one layout can be activated per request. This operation is idempotent - attempting to activate an already active layout returns an error (ALREADY_ACTIVATED)." }, { "info": { "name": "Deactivate layout with configuration transfer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/layouts/:id/actions/activate", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the layout to activate or deactivate. Must be a valid layout ID that exists within the specified module. Layout ID values are data center-specific." }, { "name": "module", "value": "", "type": "query", "description": "The CRM module API name that contains the layout. Supports both standard Zoho CRM modules (e.g., Leads, Contacts, Deals) and custom modules created in the organization. Module names follow PascalCase convention and may contain underscores for custom modules." }, { "name": "transfer_to", "value": "", "type": "query", "description": "The ID of an active layout within the same module to transfer the configuration to. Must be different from the layout being deactivated. The target layout must not have any conflicting configurations." } ] }, "docs": "Deactivates an active layout and transfers its configuration (profile associations, permissions, field mappings) to another active layout within the same module. At least one active layout must remain in the module. This operation is idempotent - attempting to deactivate an already deactivated layout returns an error (ALREADY_DEACTIVATED)." }, { "info": { "name": "GET /settings/automation/assignment_rules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/assignment_rules", "params": [ { "name": "module", "value": "", "type": "query", "description": "API name of the module" }, { "name": "include_inner_details", "value": "", "type": "query", "description": "To include the fields or keys of the another resource" } ] }, "docs": "To get all assignment rules" }, { "info": { "name": "GET /settings/automation/assignment_rules/1234567890", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/assignment_rules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique numeric identifier of assignment rule(long datatype)" }, { "name": "include_inner_details", "value": "", "type": "query", "description": "To include the fields or keys of the another resource" }, { "name": "module", "value": "", "type": "query", "description": "API name of the module" } ] }, "docs": "To get details of given assignment rule" }, { "info": { "name": "List CRM profiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/profiles", "params": [ { "name": "type", "value": "", "type": "query", "description": "Filter profiles by type." }, { "name": "include_types", "value": "", "type": "query", "description": "Comma-separated list to include additional profile types along with Administrator, Standard, and all custom profiles." }, { "name": "filters", "value": "", "type": "query", "description": "JSON-encoded filters to apply when listing profiles." } ] }, "docs": "Retrieves the list of CRM profiles with metadata.\n\n**Scopes:**\n* ZohoCRM.settings.profiles.all\n* ZohoCRM.settings.profiles.read" }, { "info": { "name": "Clone a CRM profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/profiles/:id/actions/clone", "params": [ { "name": "id", "value": "", "type": "path", "description": "Profile identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a clone of the specified profile.\n\n**Scopes:**\n* ZohoCRM.settings.profiles.all\n* ZohoCRM.settings.profiles.read" }, { "info": { "name": "Get a CRM profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Profile identifier." } ] }, "docs": "Retrieves the details of a specific CRM profile by ID.\n\n**Scopes:**\n* ZohoCRM.settings.profiles.all\n* ZohoCRM.settings.profiles.read" }, { "info": { "name": "Update a CRM profile", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Profile identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing CRM profile by ID.\n\n**Scopes:**\n* ZohoCRM.settings.profiles.all\n* ZohoCRM.settings.profiles.read" }, { "info": { "name": "Delete a CRM profile", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Profile identifier." }, { "name": "transfer_to_id", "value": "", "type": "query", "description": "Profile ID to which users of the deleted profile will be transferred." } ] }, "docs": "Deletes an existing CRM profile by ID.\n\n**Scopes:**\n* ZohoCRM.settings.profiles.all\n* ZohoCRM.settings.profiles.delete" }, { "info": { "name": "To retrieve all field updates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/field_updates", "params": [ { "name": "sort_order", "value": "", "type": "query", "description": "To sort the available list of field updates in either ascending or descending order, based on the value of \"sort_by\" parameter" }, { "name": "sort_by", "value": "", "type": "query", "description": "To sort the list of field updates. By default, the response is sorted by Created_Time. " }, { "name": "include_inner_details", "value": "", "type": "query", "description": "To retrieve additional details about the field associated with each field update." }, { "name": "page", "value": "", "type": "query", "description": "To get the list of field updates from the respective pages. The default value is 1" }, { "name": "per_page", "value": "", "type": "query", "description": "Specify how many field updates to return per page. The default and the maximum possible value is 200" } ] }, "docs": "Retrieve all available field updates" }, { "info": { "name": "To create a field update action", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/automation/field_updates", "body": { "type": "json", "data": "{}" } }, "docs": "To create a field update action in the Automation module. This action modifies field values when triggered by workflows, blueprints, or approval processes." }, { "info": { "name": "To delete multiple field update actions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/automation/field_updates", "params": [ { "name": "ids", "value": "", "type": "query", "description": "The unique field update IDs you want to delete" } ] }, "docs": "To delete multiple field update actions configured" }, { "info": { "name": "To retrieve a field update action by fieldUpdate ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/field_updates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Field Update action id in url path" }, { "name": "include_inner_details", "value": "", "type": "query", "description": "To retrieve additional details about the field associated with the field update." } ] }, "docs": "Retrieves the details of the field-update action for the specified fieldUpdate ID." }, { "info": { "name": "To update an existing field update action", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/automation/field_updates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Field Update action id in url path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update an existing field update action." }, { "info": { "name": "To delete a fieldupdate action", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/automation/field_updates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Field Update action id in url path" } ] }, "docs": "To delete a field update action." }, { "info": { "name": "Retrieve all shift hours", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/business_hours/shift_hours" }, "docs": "Retrieves all configured shift hours including shift timing, break hours, users, and holidays for each shift." }, { "info": { "name": "Create new shifts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/business_hours/shift_hours", "body": { "type": "json", "data": "{}" } }, "docs": "Creates one or more new shift hour configurations with timing, break hours, and timezone settings." }, { "info": { "name": "Update multiple shift hours", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/business_hours/shift_hours", "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more existing shift hour configurations with new timing, break hours, or timezone settings." }, { "info": { "name": "Retrieve a specific shift hour", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/business_hours/shift_hours/:shift", "params": [ { "name": "shift", "value": "", "type": "path", "description": "Unique identifier of the shift hour" } ] }, "docs": "Retrieves detailed information about a specific shift hour configuration including timing, breaks, users, and holidays." }, { "info": { "name": "Update a specific shift hour", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/business_hours/shift_hours/:shift", "params": [ { "name": "shift", "value": "", "type": "path", "description": "Unique identifier of the shift hour" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific shift hour configuration with new timing, break hours, or timezone settings." }, { "info": { "name": "Delete a specific shift hour", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/business_hours/shift_hours/:shift", "params": [ { "name": "shift", "value": "", "type": "path", "description": "Unique identifier of the shift hour" } ] }, "docs": "Deletes a specific shift hour configuration. This operation cannot be undone." }, { "info": { "name": "Retrieve inventory templates list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/inventory_templates", "params": [ { "name": "module", "value": "", "type": "query", "description": "Module API name." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field name to sort by (e.g., modified_time, name)" }, { "name": "sort_order", "value": "", "type": "query", "description": "Sort order; default is desc" }, { "name": "category", "value": "", "type": "query", "description": "Filter by template category. Values: normal (active templates), draft (saved drafts)" }, { "name": "filters", "value": "", "type": "query", "description": "JSON-stringified filter expression. See operation description for supported comparators and group_operator.\n" }, { "name": "per_page", "value": "", "type": "query", "description": "Number of items per page (default = 20, max = 100)" }, { "name": "page", "value": "", "type": "query", "description": "Page number, starting at 1" } ] }, "docs": "Retrieve a paginated list of inventory templates with support for sorting, filtering, and category selection. Use page/per_page for pagination (default: 20 per page, max: 200). Supports sorting by any field and filtering via JSON-stringified filter expressions." }, { "info": { "name": "Get all wizards with basic details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/wizards", "params": [ { "name": "module", "value": "", "type": "query", "description": "Module in which the wizard has been created." } ] }, "docs": "This API is used to get all the wizards' basic information available in the CRM account. You can filter the response by providing the module name as a query parameter." }, { "info": { "name": "Get Fields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/fields", "params": [ { "name": "module", "value": "", "type": "query", "description": "The API name of the module to which the field belongs." }, { "name": "include", "value": "", "type": "query", "description": "To include additional information about the field's permissions to update." }, { "name": "type", "value": "", "type": "query", "description": "The usage type of the field." } ] }, "docs": "Retrieve all fields metadata for modules. Examples and schemas derived from provided sample and schema files." }, { "info": { "name": "Create Fields", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/fields", "params": [ { "name": "module", "value": "", "type": "query", "description": "The API name of the module to which the field belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To create custom fields in a module in your Zoho CRM account." }, { "info": { "name": "Update Fields", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/settings/fields", "params": [ { "name": "module", "value": "", "type": "query", "description": "The API name of the module to which the field belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update custom fields in your Zoho CRM account." }, { "info": { "name": "Get Field by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/fields/:fieldId", "params": [ { "name": "module", "value": "", "type": "query", "description": "The API name of the module to which the field belongs." }, { "name": "fieldId", "value": "", "type": "path", "description": "Unique ID of the custom field to be retrieved" }, { "name": "include", "value": "", "type": "query", "description": "To include additional information about the field's permissions to update." }, { "name": "type", "value": "", "type": "query", "description": "The usage type of the field." } ] }, "docs": "Retrieve metadata of a specific custom field in a module using the field ID." }, { "info": { "name": "Update Field by ID", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/settings/fields/:fieldId", "params": [ { "name": "module", "value": "", "type": "query", "description": "The API name of the module to which the field belongs." }, { "name": "fieldId", "value": "", "type": "path", "description": "ID of the custom field to delete" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Custom Field with related to specific module of Zoho CRM Account" }, { "info": { "name": "Delete Custom Field", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/fields/:fieldId", "params": [ { "name": "fieldId", "value": "", "type": "path", "description": "ID of the custom field to delete" }, { "name": "module", "value": "", "type": "query", "description": "The API name of the module to which the field belongs." } ] }, "docs": "Delete a custom field from a module. Field must not be used in workflows, approvals, scoring rules, or other configurations. Only one field can be deleted per request." }, { "info": { "name": "Get portals", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/portals" }, "docs": "Retrieve a details of portals data." }, { "info": { "name": "Create portals", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/portals", "body": { "type": "json", "data": "{}" } }, "docs": "Create portals for the organization to provide access for end customer." }, { "info": { "name": "Get portal details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/portals/:portal", "params": [ { "name": "portal", "value": "", "type": "path", "description": "Portal identifier" } ] }, "docs": "Retrieve details for a specific portal by its identifier." }, { "info": { "name": "Update portal", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/portals/:portal", "params": [ { "name": "portal", "value": "", "type": "path", "description": "Portal identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update portal settings for the specified portal identifier." }, { "info": { "name": "Delete portal", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/portals/:portal", "params": [ { "name": "portal", "value": "", "type": "path", "description": "Portal identifier" } ] }, "docs": "Delete portal settings for the specified portal identifier." }, { "info": { "name": "List territory users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/territories/:territory/users", "params": [ { "name": "territory", "value": "", "type": "path", "description": "The ID of the territory." } ] }, "docs": "Return users for a territory." }, { "info": { "name": "Add users", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/territories/:territory/users", "params": [ { "name": "territory", "value": "", "type": "path", "description": "Parameter `territory` in `path`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add users to a territory." }, { "info": { "name": "Remove users", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/territories/:territory/users", "params": [ { "name": "territory", "value": "", "type": "path", "description": "Parameter `territory` in `path`." }, { "name": "ids", "value": "", "type": "query", "description": "Parameter `ids` in `query`." } ] }, "docs": "Remove users from a territory." }, { "info": { "name": "Get user details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/territories/:territory/users/:user", "params": [ { "name": "territory", "value": "", "type": "path", "description": "Parameter `territory` in `path`." }, { "name": "user", "value": "", "type": "path", "description": "Parameter `user` in `path`." } ] }, "docs": "Return a specific user in a territory." }, { "info": { "name": "Add specific user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/territories/:territory/users/:user", "params": [ { "name": "territory", "value": "", "type": "path", "description": "Parameter `territory` in `path`." }, { "name": "user", "value": "", "type": "path", "description": "Parameter `user` in `path`." } ] }, "docs": "Add a specific user to a territory." }, { "info": { "name": "Remove user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/territories/:territory/users/:user", "params": [ { "name": "territory", "value": "", "type": "path", "description": "Parameter `territory` in `path`." }, { "name": "user", "value": "", "type": "path", "description": "Parameter `user` in `path`." } ] }, "docs": "Remove a specific user from a territory." }, { "info": { "name": "Retrieve field dependencies for a layout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/layouts/:layoutId/map_dependency", "params": [ { "name": "layoutId", "value": "", "type": "path", "description": "The unique identifier of the layout" }, { "name": "module", "value": "", "type": "query", "description": "API name of the module to which the layout belongs" }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve. Defaults to 1 if not specified." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of records to retrieve per page. Defaults to 20 if not specified." }, { "name": "filters", "value": "", "type": "query", "description": "Filter criteria for field dependencies in JSON format. Maximum length is 100 characters." } ] }, "docs": "Retrieves the list of field dependencies for a specific layout in a module. The response includes parent and child field relationships and its additional metadata." }, { "info": { "name": "Create a new field dependency for a layout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/layouts/:layoutId/map_dependency", "headers": [ { "name": "X-ZCSRF-TOKEN", "value": "" } ], "params": [ { "name": "module", "value": "", "type": "query", "description": "API name of the module to which the layout belongs" }, { "name": "layoutId", "value": "", "type": "path", "description": "The unique identifier of the layout" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new field dependency mapping between parent and child fields in a specific layout. The dependency defines how child field values are controlled based on parent field selections." }, { "info": { "name": "Retrieve a specific field dependency by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/layouts/:layoutId/map_dependency/:dependencyId", "params": [ { "name": "module", "value": "", "type": "query", "description": "API name of the module to which the layout belongs" }, { "name": "layoutId", "value": "", "type": "path", "description": "The unique identifier of the layout" }, { "name": "dependencyId", "value": "", "type": "path", "description": "The unique identifier of the map dependency" } ] }, "docs": "Retrieves detailed information about a specific field dependency including parent and child field relationships with picklist value mappings." }, { "info": { "name": "Update an existing field dependency", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/layouts/:layoutId/map_dependency/:dependencyId", "params": [ { "name": "module", "value": "", "type": "query", "description": "API name of the module to which the layout belongs" }, { "name": "layoutId", "value": "", "type": "path", "description": "The unique identifier of the layout" }, { "name": "dependencyId", "value": "", "type": "path", "description": "The unique identifier of the map dependency" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the picklist value mappings for an existing field dependency. Use \"_delete\": null to remove specific mappings." }, { "info": { "name": "Delete a field dependency", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/layouts/:layoutId/map_dependency/:dependencyId", "params": [ { "name": "module", "value": "", "type": "query", "description": "API name of the module to which the layout belongs" }, { "name": "layoutId", "value": "", "type": "path", "description": "The unique identifier of the layout" }, { "name": "dependencyId", "value": "", "type": "path", "description": "The unique identifier of the map dependency" } ] }, "docs": "Deletes an existing field dependency from a specific layout. This operation permanently removes the dependency mapping between parent and child fields." }, { "info": { "name": "To get the Call preferences of the user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/call_preferences" }, "docs": "This will return the user preferred Call preference details that is used to display the from number / to number field in CRM" }, { "info": { "name": "Updating Call preference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/call_preferences", "body": { "type": "json", "data": "{}" } }, "docs": "This will update the user's Call preference" }, { "info": { "name": "Get Record Locking Configuration Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/record_locking_configurations", "params": [ { "name": "module", "value": "", "type": "query", "description": "The API name of the module for which the record locking configuration is to be retrieved." } ] }, "docs": "To retrieve the record locking configuration for different modules." }, { "info": { "name": "Create Record Locking Configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/record_locking_configurations", "params": [ { "name": "module", "value": "", "type": "query", "description": "The API name of the module for which the record locking configuration is to be retrieved." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To add record locking configuration for different modules." }, { "info": { "name": "Update Record Locking Configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/record_locking_configurations", "params": [ { "name": "module", "value": "", "type": "query", "description": "The API name of the module for which the record locking configuration is to be retrieved." } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update the record locking configuration for different modules." }, { "info": { "name": "Delete Record Locking Configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/record_locking_configurations", "params": [ { "name": "module", "value": "", "type": "query", "description": "The name of the module for which the record locking configuration is to be deleted." }, { "name": "ids", "value": "", "type": "query", "description": "Comma-separated IDs of the record locking configurations to be deleted." } ] }, "docs": "To delete the record locking configuration for different modules." }, { "info": { "name": "Get Record Locking Configuration by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/record_locking_configurations/:id", "params": [ { "name": "module", "value": "", "type": "query", "description": "Api name of the module" }, { "name": "id", "value": "", "type": "path", "description": "Record Locking Configuration ID" } ] }, "docs": "To retrieve the record locking configuration for different modules,pass the configuration ID through the URL" }, { "info": { "name": "Update Record Locking Configuration by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/record_locking_configurations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Record Locking Configuration ID" }, { "name": "module", "value": "", "type": "query", "description": "module api_name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update the record locking configuration for different modules, pass the configuration ID through the URL" }, { "info": { "name": "Delete Record Locking Configuration by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/record_locking_configurations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Record Locking Configuration ID" }, { "name": "module", "value": "", "type": "query", "description": "Api name of the module" } ] }, "docs": "To delete the record locking configuration for different modules,pass the configuration ID through the URL." }, { "info": { "name": "List portal users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/portals/:portal/user_type/:userType/users", "params": [ { "name": "portal", "value": "", "type": "path", "description": "The unique identifier of the portal" }, { "name": "userType", "value": "", "type": "path", "description": "The type of portal user to filter by" }, { "name": "page", "value": "", "type": "query", "description": "The page number to retrieve." }, { "name": "per_page", "value": "", "type": "query", "description": "The number of records to return per page." }, { "name": "Source__s", "value": "", "type": "query", "description": "The source of the user record." }, { "name": "filters", "value": "", "type": "query", "description": "The filters of the user record." } ] }, "docs": "Retrieve users of a specific portal filtered by user type." }, { "info": { "name": "delete portal users", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/portals/:portal/user_type/:userType/users", "params": [ { "name": "portal", "value": "", "type": "path", "description": "The unique identifier of the portal" }, { "name": "userType", "value": "", "type": "path", "description": "The type of portal user to filter by" }, { "name": "personality_ids", "value": "", "type": "query", "description": "List for record IDs of portal users to be deleted." } ] }, "docs": "Retrieve users of a specific portal filtered by user type." }, { "info": { "name": "Transfer portal users from one user group to another", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/portals/:portal/user_type/:userType/users/action/transfer", "params": [ { "name": "portal", "value": "", "type": "path", "description": "The unique identifier of the portal" }, { "name": "userType", "value": "", "type": "path", "description": "The type of portal user to filter by" }, { "name": "transfer_To", "value": "", "type": "query", "description": "User type identifier" }, { "name": "personality_ids", "value": "", "type": "query", "description": "Comma separated Record ids of portal user with encoded format" } ] }, "docs": "Transferring portal user from one user group to another user group within the same portal." }, { "info": { "name": "Change status of portal users", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/portals/:portal/user_type/:userType/users/:recordId/actions/change_status", "params": [ { "name": "portal", "value": "", "type": "path", "description": "The unique identifier of the portal" }, { "name": "userType", "value": "", "type": "path", "description": "The type of portal user to filter by" }, { "name": "recordId", "value": "", "type": "path", "description": "The unique identifier of the record" }, { "name": "active", "value": "", "type": "query", "description": "The unique identifier of the record" } ] }, "docs": "Changing portal users status." }, { "info": { "name": "Change status of portal users in bulk", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/portals/:portal/user_type/:userType/users/actions/change_status", "params": [ { "name": "portal", "value": "", "type": "path", "description": "The unique identifier of the portal" }, { "name": "userType", "value": "", "type": "path", "description": "The type of portal user to filter by" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changing portal users status in bulk." }, { "info": { "name": "GET /settings/fiscal_year", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/fiscal_year" }, "docs": "API DOC : https://learn.zoho.in/portal/zohocorp/manual/v3-apis-1/article/custom-fiscal-year-support" }, { "info": { "name": "PUT /settings/fiscal_year", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/fiscal_year", "body": { "type": "json", "data": "{}" } }, "docs": "Only Admins can update Fiscal YearAPI DOC : https://learn.zoho.in/portal/zohocorp/manual/v3-apis-1/article/custom-fiscal-year-support" }, { "info": { "name": "Retrieve CRM module metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/modules", "params": [ { "name": "status", "value": "", "type": "query", "description": "Filter modules by their visibility status. Accepts comma-separated values to retrieve modules matching any of the specified statuses. Case-sensitive." }, { "name": "feature_name", "value": "", "type": "query", "description": "Filter modules by feature name. Retrieves modules associated with the specified feature. Case-sensitive, follows snake_case format. Empty string returns 400 error." }, { "name": "include", "value": "", "type": "query", "description": "Comma-separated list of additional fields to include in the response. Allows retrieving optional module metadata that is not returned by default." } ] }, "docs": "Fetches metadata for CRM modules including configuration, capabilities, and structural information. Supports filtering by feature name to retrieve modules associated with specific features, or by status (e.g., `system_hidden`) to return modules matching that status. When both `status` and `feature_name` are provided, modules must satisfy both criteria (AND logic). Expected latency: ~60ms." }, { "info": { "name": "Create a custom CRM module", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/modules", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a single custom module in the CRM. Requires the Crm_Implied_Customize_Zoho_CRM permission. This operation is not idempotent; submitting the same api_name multiple times will result in validation errors. Only one module can be created per request; batch creation is not supported." }, { "info": { "name": "Update CRM modules", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/modules", "body": { "type": "json", "data": "{}" } }, "docs": "Updates existing modules in the CRM. Allows modification of module labels and profile assignments. This operation is idempotent; the same request can be safely repeated. Supports batch updates - multiple modules can be updated in a single request. Returns 200 when all modules update successfully, or 207 Multi-Status when some succeed and others fail." }, { "info": { "name": "Get module metadata by API name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/modules/:moduleIdentifier", "params": [ { "name": "moduleIdentifier", "value": "", "type": "path", "description": "Identifier for the module to retrieve, either numeric ID or API name. Use numeric ID for precise identification or API name for human-readable reference. Case-sensitive when using API name." } ] }, "docs": "Retrieves complete metadata for a specific CRM module identified by its API name. Returns comprehensive configuration including fields, layouts, profiles, related lists, custom views, and module capabilities." }, { "info": { "name": "Update module labels and profiles", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/modules/:moduleIdentifier", "params": [ { "name": "moduleIdentifier", "value": "", "type": "path", "description": "Identifier for the module to retrieve, either numeric ID or API name. Use numeric ID for precise identification or API name for human-readable reference. Case-sensitive when using API name." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially updates a module's display labels (singular and plural) and associated profile permissions. This operation only modifies the specified fields without affecting other module configuration. The operation is idempotent - calling it multiple times with the same payload produces the same result." }, { "info": { "name": "Get all layouts metadata for a module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/layouts", "params": [ { "name": "module", "value": "", "type": "query", "description": "Specify the API name of the required module. Supports both standard modules (Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price_Books, Quotes, Sales_Orders, Purchase_Orders, Invoices, Appointments, Services) and custom modules. Module API names are case-insensitive, can contain alphanumeric characters and underscores, must not contain spaces, and have a maximum length of 50 characters. Use the GET - Modules Metadata API to retrieve all available module API names." }, { "name": "mode", "value": "", "type": "query", "description": "Filter layouts by mode. Available modes vary by module type:\n- `business_card`: Business card layout view\n- `quick_create`: Quick create form layout\n- `all`: Request all available modes\n\nIf not provided, the default mode for the module will be applied. Note: Mode availability depends on the module and its configuration." }, { "name": "include", "value": "", "type": "query", "description": "Specifies additional data to include in the response." }, { "name": "include_inner_details", "value": "", "type": "query", "description": "Specifies additional inner details to include in the response. Accepts a comma-separated list of dot-notation paths indicating which nested properties should return extended information." } ] }, "docs": "Retrieves comprehensive details of all layouts associated with a specified module in your Zoho CRM account. Returns layout configuration including sections, fields, profiles, and permissions in a single response without pagination.\n\n**Important Notes:**\n- The `profiles` array will be `null` if the user does not have \"Module Customization\" permission in their profile.\n- For Deals module: When the pipeline feature is enabled, multiple layouts exist per pipeline. Each pipeline can have its own set " }, { "info": { "name": "Get a specific layout metadata by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/layouts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the layout. Must be a valid 64-bit integer represented as a string. Can be obtained from the Get Layouts API." }, { "name": "module", "value": "", "type": "query", "description": "Specify the API name of the required module. Supports both standard modules (Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price_Books, Quotes, Sales_Orders, Purchase_Orders, Invoices, Appointments, Services) and custom modules. Module API names are case-insensitive, can contain alphanumeric characters and underscores, must not contain spaces, and have a maximum length of 50 characters. Use the GET - Modules Metadata API to retrieve all available module API names." }, { "name": "mode", "value": "", "type": "query", "description": "Filter layouts by mode. Available modes vary by module type:\n- `business_card`: Business card layout view\n- `quick_create`: Quick create form layout\n- `all`: Request all available modes\n\nIf not provided, the default mode for the module will be applied. Note: Mode availability depends on the module and its configuration." }, { "name": "include", "value": "", "type": "query", "description": "Specifies additional data to include in the response." }, { "name": "include_inner_details", "value": "", "type": "query", "description": "Specifies additional inner details to include in the response. Accepts a comma-separated list of dot-notation paths indicating which nested properties should return extended information." } ] }, "docs": "Retrieves comprehensive details of a specific layout by its unique identifier for a specified module in your Zoho CRM account. Returns layout configuration including sections, fields, profiles, and permissions.\n\n**Important Notes:**\n- The `profiles` array will be `null` if the user does not have \"Module Customization\" permission in their profile.\n- For Deals module: When the pipeline feature is enabled, multiple layouts exist per pipeline. Each pipeline can have its own set of layouts.\n- The `mo" }, { "info": { "name": "Delete a custom layout", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/layouts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the layout. Must be a valid 64-bit integer represented as a string. Can be obtained from the Get Layouts API." }, { "name": "module", "value": "", "type": "query", "description": "Specify the API name of the required module. Supports both standard modules (Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price_Books, Quotes, Sales_Orders, Purchase_Orders, Invoices, Appointments, Services) and custom modules. Module API names are case-insensitive, can contain alphanumeric characters and underscores, must not contain spaces, and have a maximum length of 50 characters. Use the GET - Modules Metadata API to retrieve all available module API names." }, { "name": "transfer_to", "value": "", "type": "query", "description": "The ID of the layout to which records associated with the layout being deleted should be transferred. This parameter is conditionally mandatory - it is required when the layout has records associated with it. It is only optional when the layout is deactivated and has no records associated. The target layout must be an active layout; transferring to a deactivated layout is not allowed." }, { "name": "pipeline", "value": "", "type": "query", "description": "The ID of the pipeline to transfer records to. This parameter is conditionally mandatory - it must be provided along with the `stage` parameter when the layout being deleted has an associated pipeline. Required for modules like Deals that support pipeline stages." }, { "name": "stage", "value": "", "type": "query", "description": "The ID of the stage within the pipeline to transfer records to. This parameter is conditionally mandatory - it must be provided along with the `pipeline` parameter when the layout being deleted has an associated pipeline. The stage must be a valid stage within the specified pipeline." } ] }, "docs": "Deletes a custom layout from a module in Zoho CRM. When deleting a layout that has associated records, you must specify a `transfer_to` layout ID to transfer those records. If the layout has an associated pipeline, you must also provide `pipeline` and `stage` parameters. The `transfer_to` parameter is only optional when the layout is deactivated and has no records associated with it. Note: The standard layout cannot be deleted." }, { "info": { "name": "GET /settings/variables", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/variables" }, "docs": "This helps in fetching all the variables" }, { "info": { "name": "POST /settings/variables", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/variables", "body": { "type": "json", "data": "{}" } }, "docs": "this creates variables." }, { "info": { "name": "PUT /settings/variables", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/variables", "body": { "type": "json", "data": "{}" } }, "docs": "Updates all variables" }, { "info": { "name": "DELETE /settings/variables", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/variables", "params": [ { "name": "ids", "value": "", "type": "query", "description": "param field for variable with id" }, { "name": "rids", "value": "", "type": "query", "description": "param field for variable with rid" } ] }, "docs": "Delete all" }, { "info": { "name": "GET /settings/variables/1234567890", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/variables/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "variables id in url path" }, { "name": "group", "value": "", "type": "query", "description": "Field to filter variables from variable groups id" }, { "name": "group_rid", "value": "", "type": "query", "description": "Field to filter variables from variable groups rid" } ] }, "docs": "Get Variables by ID" }, { "info": { "name": "PUT /settings/variables/1234567890", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/variables/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "variables id in url path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "updates variables based on id" }, { "info": { "name": "DELETE /settings/variables/1234567890", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/variables/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "variables id in url path" } ] }, "docs": "used to delete particular variables" }, { "info": { "name": "GET /settings/unsubscribe_links", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/unsubscribe_links" }, "docs": "To get all unsubscribe links" }, { "info": { "name": "POST /settings/unsubscribe_links", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/unsubscribe_links", "body": { "type": "json", "data": "{}" } }, "docs": "To create an unsubscribe link" }, { "info": { "name": "PUT /settings/unsubscribe_links", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/unsubscribe_links", "body": { "type": "json", "data": "{}" } }, "docs": "To update an unsubscribe link." }, { "info": { "name": "GET /settings/unsubscribe_links/111111000000115718", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/unsubscribe_links/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "unsubscribe links id in url path" } ] }, "docs": "To get unsubscribe link by id" }, { "info": { "name": "PUT /settings/unsubscribe_links/111111000000115722", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/unsubscribe_links/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "unsubscribe links id in url path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "To update an unsubscribe link." }, { "info": { "name": "DELETE /settings/unsubscribe_links/111111000000115722", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/unsubscribe_links/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "unsubscribe links id in url path" } ] }, "docs": "To delete an unsubscribe link." }, { "info": { "name": "GET /settings/unsubscribe_link/actions/associations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/unsubscribe_link/actions/associations" }, "docs": "To obtain information regarding the associations of unsubscribe links configured in your account." }, { "info": { "name": "this endpoint is used to get tags from a module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/tags", "params": [ { "name": "module", "value": "", "type": "query", "description": "Module api name" }, { "name": "include", "value": "", "type": "query", "description": "It defines whether the tag is associated to configurations, associated record counts and when the tag is last associated to a record." } ] }, "docs": "to get tags from a module" }, { "info": { "name": "POST /settings/tags", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/tags", "params": [ { "name": "module", "value": "", "type": "query", "description": "Module api name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is used to create tags" }, { "info": { "name": "PUT /settings/tags", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/tags", "params": [ { "name": "module", "value": "", "type": "query", "description": "Module api name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Put API with Tag id in request body" }, { "info": { "name": "PUT /settings/tags/{id}", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/tags/:id", "params": [ { "name": "id", "value": "", "type": "query", "description": "Tag id" }, { "name": "id", "value": "", "type": "path", "description": "Path parameter: id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is used to update the tag details" }, { "info": { "name": "DELETE /settings/tags/{id}", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/tags/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter: id" } ] }, "docs": "This endpoint is used to delete Tags" }, { "info": { "name": "Get status of mass delete job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/tags/actions/mass_delete" }, "docs": "Retrieve the status of a scheduled mass delete job using its job_id" }, { "info": { "name": "Schedule mass delete tags job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/tags/actions/mass_delete", "body": { "type": "json", "data": "{}" } }, "docs": "Schedules a job to delete multiple tags across modules in Zoho CRM." }, { "info": { "name": "GET - Get all cadences", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/automation/cadences", "params": [ { "name": "module", "value": "", "type": "query", "description": "Cadence supported modules like Leads, Contacts, Accounts, Deals, Quotes, Vendors or custom module" }, { "name": "name", "value": "", "type": "query", "description": "Filters by cadence name" }, { "name": "active", "value": "", "type": "query", "description": "Filters by cadence active status. Use true or false" }, { "name": "fields", "value": "", "type": "query", "description": "Filters by fields. Use name" }, { "name": "page", "value": "", "type": "query", "description": "Page number to be accessed" }, { "name": "per_page", "value": "", "type": "query", "description": "Number of items per page" } ] }, "docs": "Get all cadences" }, { "info": { "name": "Get all territories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/territories", "params": [ { "name": "include", "value": "", "type": "query", "description": "Parameter `include` in `query`." }, { "name": "ids", "value": "", "type": "query", "description": "Parameter `ids` in `query`." }, { "name": "page", "value": "", "type": "query", "description": "Parameter `page` in `query`." }, { "name": "per_page", "value": "", "type": "query", "description": "Parameter `per_page` in `query`." }, { "name": "filters", "value": "", "type": "query", "description": "Parameter `filters` in `query`." }, { "name": "include_inner_details", "value": "", "type": "query", "description": "Parameter `include_inner_details` in `query`." } ] }, "docs": "Retrieves a list of territories." }, { "info": { "name": "Create Territories", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/territories", "body": { "type": "json", "data": "{}" } }, "docs": "Auto-generated description for operation `Create Territories`." }, { "info": { "name": "Update Territory", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/territories", "body": { "type": "json", "data": "{}" } }, "docs": "Auto-generated description for operation `Update Territory`." }, { "info": { "name": "Delete Territories", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/territories", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Parameter `ids` in `query`." }, { "name": "delete_previous_forecasts", "value": "", "type": "query", "description": "Parameter `delete_previous_forecasts` in `query`." } ] }, "docs": "Auto-generated description for operation `Delete Territories`." }, { "info": { "name": "Get Territory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/territories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Parameter `id` in `path`." }, { "name": "include_inner_details", "value": "", "type": "query", "description": "Parameter `include_inner_details` in `query`." } ] }, "docs": " `Get Territory By Id`" }, { "info": { "name": "Update Territory", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/territories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Parameter `id` in `path`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Auto-generated description for operation `Update Territory`." }, { "info": { "name": "Delete Territory By Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/territories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Parameter `id` in `path`." }, { "name": "delete_previous_forecasts", "value": "", "type": "query", "description": "Parameter `delete_previous_forecasts` in `query`." } ] }, "docs": "Auto-generated description for operation `Update Territory`." }, { "info": { "name": "Transfer And Delete Territories", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/territories/actions/transfer_and_delete", "body": { "type": "json", "data": "{}" } }, "docs": "Auto-generated description for operation `Transfer And Delete Territories`." }, { "info": { "name": "Transfer And Delete Territory By Id", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/territories/:id/actions/transfer_and_delete", "params": [ { "name": "id", "value": "", "type": "path", "description": "Parameter `id` in `path`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Auto-generated description for operation `Transfer And Delete Territory By Id`." }, { "info": { "name": "Get Child Territories By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/territories/:id/__child_territories", "params": [ { "name": "include", "value": "", "type": "query", "description": "Parameter `include` in `query`." }, { "name": "id", "value": "", "type": "path", "description": "Parameter `id` in `path`." }, { "name": "page", "value": "", "type": "query", "description": "Parameter `page` in `query`." }, { "name": "per_page", "value": "", "type": "query", "description": "Parameter `per_page` in `query`." }, { "name": "filters", "value": "", "type": "query", "description": "Parameter `filters` in `query`." }, { "name": "include_inner_details", "value": "", "type": "query", "description": "Parameter `include_inner_details` in `query`." } ] }, "docs": "Auto-generated description for operation `Get Child Territories By Id`." }, { "info": { "name": "Get Associated Users Count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/territories/actions/associated_users_count" }, "docs": "Auto-generated description for operation `Get Associated Users Count`." }, { "info": { "name": "Get Data Sharing", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/data_sharing" }, "docs": "Get the data sharing settings configured.API exposed to customers" }, { "info": { "name": "Update Data Sharing", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/data_sharing", "body": { "type": "json", "data": "{}" } }, "docs": "Update the data sharing settings configured.API exposed to customers" }, { "info": { "name": "Get Pipelines", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/pipeline", "params": [ { "name": "layout_id", "value": "", "type": "query", "description": "Layout Id" } ] }, "docs": "Get pipelines for a given layout" }, { "info": { "name": "Create Pipeline", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/pipeline", "params": [ { "name": "layout_id", "value": "", "type": "query", "description": "Layout Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new pipeline for a given layout" }, { "info": { "name": "UpdateOrDelete Pipeline", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/pipeline", "params": [ { "name": "layout_id", "value": "", "type": "query", "description": "Layout Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update/Delete an pipeline" }, { "info": { "name": "UpdateOrDelete Pipeline", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/settings/pipeline", "params": [ { "name": "layout_id", "value": "", "type": "query", "description": "Layout Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update/Delete an pipeline" }, { "info": { "name": "Get Pipeline", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/pipeline/:id", "params": [ { "name": "layout_id", "value": "", "type": "query", "description": "Layout Id" }, { "name": "id", "value": "", "type": "path", "description": "Pipeline Id" } ] }, "docs": "Get particular pipeline by ID" }, { "info": { "name": "UpdateOrDelete Pipeline", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/pipeline/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Pipeline Id" }, { "name": "layout_id", "value": "", "type": "query", "description": "Layout Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update/Delete an pipeline" }, { "info": { "name": "UpdateOrDelete Pipeline", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/settings/pipeline/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Pipeline Id" }, { "name": "layout_id", "value": "", "type": "query", "description": "Layout Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update/Delete an pipeline" }, { "info": { "name": "Transfer and Delete Pipelines", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/pipeline/actions/transfer", "params": [ { "name": "layout_id", "value": "", "type": "query", "description": "Layout Id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Transfer and delete pipelines" }, { "info": { "name": "Retrieve Appointment Preferences", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/appointment_preferences", "params": [ { "name": "include", "value": "", "type": "query", "description": "Include additional related data in the response. For example, specify `deal_record_configuration` to include deal configuration details." } ] }, "docs": "Fetches the existing configuration for appointment preferences, including rules for deal creation, job sheet visibility, and mark as complete configurations." }, { "info": { "name": "Update Appointment Preferences", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/appointment_preferences", "body": { "type": "json", "data": "{}" } }, "docs": "Updates one appointment preferences in Zoho CRM. This endpoint allows configuring how appointments are handled, including deal creation." }, { "info": { "name": "Retrieve pick list values for a field", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/fields/:fieldId/pick_list_values", "params": [ { "name": "fieldId", "value": "", "type": "path", "description": "Unique numeric identifier for the field. Must be a valid field ID belonging to the specified module." }, { "name": "module", "value": "", "type": "query", "description": "API name of the CRM module containing the field. Supports standard modules (e.g., Leads, Contacts, Accounts, Deals) and custom modules. Case-insensitive." } ] }, "docs": "Returns the available pick list values for a specified field in a module, including display values (with translations if enabled), reference values, layout associations, and metadata. Returns 204 if the field exists but is not a pick list type. Does not support pagination." }, { "info": { "name": "Get All Custom Views", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/custom_views", "params": [ { "name": "module", "value": "", "type": "query", "description": "module name" }, { "name": "filters", "value": "", "type": "query", "description": "Parameter `filters` in `query`." } ] }, "docs": "Get all custom views of a module" }, { "info": { "name": "Get Custom View By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/custom_views/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "custom view id" }, { "name": "module", "value": "", "type": "query", "description": "module name" }, { "name": "include_inner_details", "value": "", "type": "query", "description": "To include inner details of criteria and cross filters" } ] }, "docs": "Get a specific custom view of a module using custom view ID" }, { "info": { "name": "Change Sort Order", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/custom_views/actions/change_sort", "params": [ { "name": "module", "value": "", "type": "query", "description": "module name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the sort order of a custom view" }, { "info": { "name": "Change Sort Order", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/custom_views/:id/actions/change_sort", "params": [ { "name": "module", "value": "", "type": "query", "description": "module name" }, { "name": "id", "value": "", "type": "path", "description": "custom view id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the sort order of a custom view" }, { "info": { "name": "get Zia Enrichment Configuration for a specific module", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/zia/data_enrichment" }, "docs": "get Zia Enrichment Configuration for a specific module" }, { "info": { "name": "Get From Addresses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/emails/actions/from_addresses" }, "docs": "Get the list of email addresses that you can send emails from." }, { "info": { "name": "GET /settings/tags/{id}/actions/records_count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/tags/:id/actions/records_count", "params": [ { "name": "id", "value": "", "type": "query", "description": "tag id" }, { "name": "module", "value": "", "type": "query", "description": "module api name" }, { "name": "id", "value": "", "type": "path", "description": "Path parameter: id" } ] }, "docs": "This endpoint is used to get the number of records associated to the tag." }, { "info": { "name": "POST /settings/tags/{id}/actions/merge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/tags/:id/actions/merge", "params": [ { "name": "id", "value": "", "type": "path", "description": "Path parameter: id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is used to merge two tags" }, { "info": { "name": "Get Exported AuditLogs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/audit_log_export" }, "docs": "Retrieves a list of audit log export jobs along with their details." }, { "info": { "name": "Create an Audit Log Export job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/audit_log_export", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new export job for audit logs based on the specified criteria." }, { "info": { "name": "Get Exported AuditLogs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/audit_log_export/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the audit log export job." } ] }, "docs": "Retrieves the details of a specific audit log export job by its ID." } ] } ], "bundled": true }