Zoho

Zoho Settings API

The Settings API from Zoho — 107 operation(s) for settings.

GitHub OpenAPI

Operations 213

GET /settings/appointment_preferences Retrieve Appointment Preferences #
PUT /settings/appointment_preferences Update Appointment Preferences #
GET /settings/automation/assignment_rules GET /settings/automation/assignment_rules #
GET /settings/automation/assignment_rules/{id} GET /settings/automation/assignment_rules/1234567890 #
POST /settings/audit_log_export Create an Audit Log Export job #
GET /settings/audit_log_export Get Exported AuditLogs #
GET /settings/audit_log_export/{id} Get Exported AuditLogs #
POST /settings/business_hours Create business hours configuration #
PUT /settings/business_hours Update business hours configuration #
GET /settings/business_hours Retrieve business hours configuration #
GET /settings/automation/cadences GET - Get all cadences #
GET /settings/call_preferences To get the Call preferences of the user #
PUT /settings/call_preferences Updating Call preference #
GET /settings/custom_views Get All Custom Views #
GET /settings/custom_views/{id} Get Custom View By Id #
PUT /settings/custom_views/actions/change_sort Change Sort Order #
PUT /settings/custom_views/{id}/actions/change_sort Change Sort Order #
GET /settings/data_sharing Get Data Sharing #
PUT /settings/data_sharing Update Data Sharing #
GET /settings/duplicate_check_preference Get Duplicate Check Preference #
POST /settings/duplicate_check_preference Create Duplicate Check Preference #
PUT /settings/duplicate_check_preference Update Duplicate Check Preference #
DELETE /settings/duplicate_check_preference Delete Duplicate Check Preference #
GET /settings/email_templates Retrieve email templates list #
GET /settings/automation/field_updates To retrieve all field updates #
POST /settings/automation/field_updates To create a field update action #
DELETE /settings/automation/field_updates To delete multiple field update actions #
GET /settings/automation/field_updates/{id} To retrieve a field update action by fieldUpdate ID #
PUT /settings/automation/field_updates/{id} To update an existing field update action #
DELETE /settings/automation/field_updates/{id} To delete a fieldupdate action #
GET /settings/fields Get Fields #
POST /settings/fields Create Fields #
PATCH /settings/fields Update Fields #
GET /settings/fields/{fieldId} Get Field by ID #
PATCH /settings/fields/{fieldId} Update Field by ID #
DELETE /settings/fields/{fieldId} Delete Custom Field #
GET /settings/fiscal_year GET /settings/fiscal_year #
PUT /settings/fiscal_year PUT /settings/fiscal_year #
GET /settings/emails/actions/from_addresses Get From Addresses #
GET /settings/global_picklists Get all global picklists #
POST /settings/global_picklists Create a new global picklist #
GET /settings/global_picklists/{id} Get a single global picklist by id #
PATCH /settings/global_picklists/{id} Update a global picklist by id #
DELETE /settings/global_picklists/{id} Delete a global picklist by id #
GET /settings/global_picklists/{id}/actions/pick_list_values_associations Get picklist value associations #
GET /settings/inventory_templates Retrieve inventory templates list #
GET /settings/layouts Get all layouts metadata for a module #
GET /settings/layouts/{id} Get a specific layout metadata by ID #
DELETE /settings/layouts/{id} Delete a custom layout #
POST /settings/layouts/{id}/actions/activate Activate layout with profile associations #
DELETE /settings/layouts/{id}/actions/activate Deactivate layout with configuration transfer #
GET /settings/layouts/{layoutId}/map_dependency Retrieve field dependencies for a layout #
POST /settings/layouts/{layoutId}/map_dependency Create a new field dependency for a layout #
GET /settings/layouts/{layoutId}/map_dependency/{dependencyId} Retrieve a specific field dependency by ID #
PUT /settings/layouts/{layoutId}/map_dependency/{dependencyId} Update an existing field dependency #
DELETE /settings/layouts/{layoutId}/map_dependency/{dependencyId} Delete a field dependency #
POST /settings/tags/actions/mass_delete Schedule mass delete tags job #
GET /settings/tags/actions/mass_delete Get status of mass delete job #
GET /settings/modules Retrieve CRM module metadata #
POST /settings/modules Create a custom CRM module #
PUT /settings/modules Update CRM modules #
GET /settings/modules/{moduleIdentifier} Get module metadata by API name #
PUT /settings/modules/{moduleIdentifier} Update module labels and profiles #
GET /settings/fields/{fieldId}/pick_list_values Retrieve pick list values for a field #
GET /settings/pipeline Get Pipelines #
POST /settings/pipeline Create Pipeline #
PATCH /settings/pipeline UpdateOrDelete Pipeline #
PUT /settings/pipeline UpdateOrDelete Pipeline #
GET /settings/pipeline/{id} Get Pipeline #
PATCH /settings/pipeline/{id} UpdateOrDelete Pipeline #
PUT /settings/pipeline/{id} UpdateOrDelete Pipeline #
POST /settings/pipeline/actions/transfer Transfer and Delete Pipelines #
GET /settings/portals/{portal}/user_type List portal user types #
POST /settings/portals/{portal}/user_type Create portal user type #
GET /settings/portals/{portal}/user_type/{userTypeId} Get portal user type #
PUT /settings/portals/{portal}/user_type/{userTypeId} Update portal user type #
DELETE /settings/portals/{portal}/user_type/{userTypeId} Delete portal user type #
GET /settings/portals/{portal}/user_type/{userType}/users List portal users #
DELETE /settings/portals/{portal}/user_type/{userType}/users delete portal users #
POST /settings/portals/{portal}/user_type/{userType}/users/action/transfer Transfer portal users from one user group to another #
POST /settings/portals/{portal}/user_type/{userType}/users/{recordId}/actions/change_status Change status of portal users #
POST /settings/portals/{portal}/user_type/{userType}/users/actions/change_status Change status of portal users in bulk #
GET /settings/portals Get portals #
POST /settings/portals Create portals #
GET /settings/portals/{portal} Get portal details #
PUT /settings/portals/{portal} Update portal #
DELETE /settings/portals/{portal} Delete portal #
GET /settings/profiles List CRM profiles #
POST /settings/profiles/{id}/actions/clone Clone a CRM profile #
PUT /settings/profiles/{id} Update a CRM profile #
GET /settings/profiles/{id} Get a CRM profile #
DELETE /settings/profiles/{id} Delete a CRM profile #
POST /settings/record_locking_configurations Create Record Locking Configuration #
PUT /settings/record_locking_configurations Update Record Locking Configuration #
GET /settings/record_locking_configurations Get Record Locking Configuration Details #
DELETE /settings/record_locking_configurations Delete Record Locking Configuration #
PUT /settings/record_locking_configurations/{id} Update Record Locking Configuration by ID #
GET /settings/record_locking_configurations/{id} Get Record Locking Configuration by ID #
DELETE /settings/record_locking_configurations/{id} Delete Record Locking Configuration by ID #
GET /settings/recycle_bin List recycle bin records #
DELETE /settings/recycle_bin Delete multiple recycle bin records #
POST /settings/recycle_bin/actions/restore Restore multiple recycle bin records #
GET /settings/recycle_bin/actions/count Get recycle bin counts #
POST /settings/recycle_bin/actions/empty Empty the recycle bin #
POST /settings/recycle_bin/{recordId}/actions/restore Restore a recycle bin record #
GET /settings/recycle_bin/{recordId} Get a recycle bin record #
DELETE /settings/recycle_bin/{recordId} Delete a recycle bin record #
GET /settings/related_lists Retrieve related lists configuration #
GET /settings/roles Get all roles #
POST /settings/roles Create new roles #
PUT /settings/roles Update multiple roles #
GET /settings/roles/{role} Get specific role #
PUT /settings/roles/{role} Update role #
DELETE /settings/roles/{role} Delete role #
GET /settings/automation/scoring_rules GET /settings/automation/scoring_rules #
PUT /settings/automation/scoring_rules PUT /settings/automation/scoring_rules #
POST /settings/automation/scoring_rules POST /settings/automation/scoring_rules #
DELETE /settings/automation/scoring_rules DELETE /settings/automation/scoring_rules #
GET /settings/automation/scoring_rules/{ruleId} GET /settings/automation/scoring_rules/{ruleId} #
PUT /settings/automation/scoring_rules/{ruleId} PUT /settings/automation/scoring_rules/{ruleId} #
DELETE /settings/automation/scoring_rules/{ruleId} DELETE /settings/automation/scoring_rules/{ruleId} #
PUT /settings/automation/scoring_rules/{ruleId}/actions/activate PUT /settings/automation/scoring_rules/{ruleId}/actions/activate #
DELETE /settings/automation/scoring_rules/{ruleId}/actions/activate DELETE /settings/automation/scoring_rules/{ruleId}/actions/activate #
POST /settings/automation/scoring_rules/{ruleId}/actions/clone POST /settings/automation/scoring_rules/{ruleId}/actions/clone #
GET /settings/service_preferences Retrieve service preference settings for the organization #
PUT /settings/service_preferences Update service preference settings for the organization #
GET /settings/business_hours/shift_hours Retrieve all shift hours #
POST /settings/business_hours/shift_hours Create new shifts #
PUT /settings/business_hours/shift_hours Update multiple shift hours #
GET /settings/business_hours/shift_hours/{shift} Retrieve a specific shift hour #
PUT /settings/business_hours/shift_hours/{shift} Update a specific shift hour #
DELETE /settings/business_hours/shift_hours/{shift} Delete a specific shift hour #
GET /settings/tags this endpoint is used to get tags from a module #
PUT /settings/tags PUT /settings/tags #
POST /settings/tags POST /settings/tags #
PUT /settings/tags/{id} PUT /settings/tags/{id} #
DELETE /settings/tags/{id} DELETE /settings/tags/{id} #
GET /settings/tags/{id}/actions/records_count GET /settings/tags/{id}/actions/records_count #
POST /settings/tags/{id}/actions/merge POST /settings/tags/{id}/actions/merge #
GET /settings/territories Get all territories #
POST /settings/territories Create Territories #
PUT /settings/territories Update Territory #
DELETE /settings/territories Delete Territories #
GET /settings/territories/{id} Get Territory #
PUT /settings/territories/{id} Update Territory #
DELETE /settings/territories/{id} Delete Territory By Id #
POST /settings/territories/actions/transfer_and_delete Transfer And Delete Territories #
POST /settings/territories/{id}/actions/transfer_and_delete Transfer And Delete Territory By Id #
GET /settings/territories/{id}/__child_territories Get Child Territories By Id #
GET /settings/territories/actions/associated_users_count Get Associated Users Count #
GET /settings/territories/{territory}/users List territory users #
PUT /settings/territories/{territory}/users Add users #
DELETE /settings/territories/{territory}/users Remove users #
GET /settings/territories/{territory}/users/{user} Get user details #
PUT /settings/territories/{territory}/users/{user} Add specific user #
DELETE /settings/territories/{territory}/users/{user} Remove user #
GET /settings/unsubscribe_links/{id} GET /settings/unsubscribe_links/111111000000115718 #
PUT /settings/unsubscribe_links/{id} PUT /settings/unsubscribe_links/111111000000115722 #
DELETE /settings/unsubscribe_links/{id} DELETE /settings/unsubscribe_links/111111000000115722 #
GET /settings/unsubscribe_link/actions/associations GET /settings/unsubscribe_link/actions/associations #
GET /settings/user_groups Get Groups #
POST /settings/user_groups Create Group #
GET /settings/user_groups/{group} Get Group #
PUT /settings/user_groups/{group} Update Group #
DELETE /settings/user_groups/{group} Delete Group #
GET /settings/user_groups/{group}/sources Get Sources #
GET /settings/user_groups/{group}/actions/sources_count Get Sources Count #
GET /settings/user_groups/actions/associated_users_count Get Associated Users Count #
GET /settings/user_groups/{group}/actions/associations Get Group associations #
GET /settings/variable_groups GET /settings/variable_groups #
PUT /settings/variable_groups PUT variable_groups #
GET /settings/variable_groups/{id} GET variable_groups by {id} #
PUT /settings/variable_groups/{id} PUT by variable_groups by id #
GET /settings/variables GET /settings/variables #
PUT /settings/variables PUT /settings/variables #
POST /settings/variables POST /settings/variables #
DELETE /settings/variables DELETE /settings/variables #
GET /settings/variables/{id} GET /settings/variables/1234567890 #
PUT /settings/variables/{id} PUT /settings/variables/1234567890 #
DELETE /settings/variables/{id} DELETE /settings/variables/1234567890 #
GET /settings/automation/webhooks GET /settings/automation/webhooks #
PUT /settings/automation/webhooks PUT /settings/automation/webhooks #
POST /settings/automation/webhooks POST /settings/automation/webhooks #
DELETE /settings/automation/webhooks DELETE /settings/automation/webhooks #
GET /settings/automation/webhooks/{webhookId} GET /settings/automation/webhooks/{webhookId} #
PUT /settings/automation/webhooks/{webhookId} PUT /settings/automation/webhooks #
DELETE /settings/automation/webhooks/{webhookId} DELETE /settings/automation/webhooks/{webhookId} #
GET /settings/automation/webhook_failures GET /settings/automation/webhook_failures #
GET /settings/automation/webhooks/actions/associated_modules GET /settings/automation/webhooks/actions/associated_modules #
GET /settings/automation/webhooks/actions/usage_reports GET /settings/automation/webhooks/actions/usage_reports #
GET /settings/wizards Get all wizards with basic details #
POST /settings/automation/workflow_rules Configure a Workflow rule #
PUT /settings/automation/workflow_rules Update Workflow Rule For the Given ID in Body #
GET /settings/automation/workflow_rules Get All WorkflowRules #
DELETE /settings/automation/workflow_rules Delete Multiple Workflow Rules #
PUT /settings/automation/workflow_rules/{id} Update Workflow Rule By ID #
GET /settings/automation/workflow_rules/{id} Retrieve a single workflow #
DELETE /settings/automation/workflow_rules/{id} Delete Workflow Rule By ID #
GET /settings/automation/workflow_rules/actions/actions_count Get Workflow Rule actions count #
GET /settings/automation/workflow_rules/actions/module_specific_count Get Workflow Rule actions count for each module #
GET /settings/automation/workflow_rules/actions/rules_count Get Workflow Rules count #
GET /settings/automation/workflow_rules/{workflowRuleId}/actions/usage To retrieve Workflow Rule usage #
PUT /settings/automation/workflow_rules/actions/reorder To reorder workflow rules #
GET /settings/automation/tasks GET /settings/automation/tasks #
POST /settings/automation/tasks POST /settings/automation/tasks #
DELETE /settings/automation/tasks DELETE /settings/automation/tasks #
GET /settings/automation/tasks/{id} GET /settings/automation/tasks/{id} #
PUT /settings/automation/tasks/{id} PUT /settings/automation/tasks/123445566 #
DELETE /settings/automation/tasks/{id} DELETE /settings/automation/tasks/{id} #
GET /settings/zia/data_enrichment get Zia Enrichment Configuration for a specific module #

Documentation

📖
Documentation
https://www.zoho.com/crm/developer/docs/api/
📖
APIReference
https://www.zoho.com/crm/developer/docs/api/v8/
📖
GettingStarted
https://www.zoho.com/crm/developer/docs/
📖
Documentation
https://desk.zoho.com/DeskAPIDocument
📖
Documentation
https://www.zoho.com/analytics/api/v2/introduction.html
📖
APIReference
https://www.zoho.com/analytics/api/v2/
📖
Documentation
https://www.bigin.com/developer/docs/apis/v2/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-settings-api-openapi.yml

Code Examples

💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-Sample-apps-iOS
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-android
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-flutter
💻
CodeExamples
https://github.com/zoho/ZohoDesk-PortalSDK-sample-apps-reactnative
💻
CodeExamples
https://github.com/zoho/Zoho-Desk-ASAP-Mobile-SDK-API-Samples
💻
CodeExamples
https://github.com/zoho/analytics-codestudio

Other Resources

🔗
SDKs
https://packagist.org/packages/zohocrm/php-sdk-8.0
🔗
SDKs
https://pypi.org/project/zohocrmsdk8-0/
🔗
SDKs
https://www.nuget.org/packages/ZOHOCRMSDK-8.0/
🔗
SDKs
https://github.com/zoho/zohocrm-java-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/nodejs-sdk-8.0
🔗
SDKs
https://www.npmjs.com/package/@zohocrm/typescript-sdk-8.0
🔗
SDKs
https://rubygems.org/gems/ZOHOCRMSDK8_0
🔗
SDKs
https://github.com/zoho/zohocrm-javascript-sdk-8.0
🔗
SDKs
https://github.com/zoho/zohocrm-scala-sdk-8.0
🔗
SDKs
https://cocoapods.org/pods/ZCRMiOS
🔗
DeveloperPortal
https://www.zoho.com/desk/developers/
🔗
SDKs
https://github.com/zoho/ZohoDeskPortalSDK
🔗
SDKs
https://github.com/zoho/react-native-zohodesk-portal-sdk
🔗
SDKs
https://github.com/zoho/zdesk-asap-flutter
🔗
SDKs
https://github.com/zoho/cordova-plugin-zohodesk-portal
🔗
Tools
https://github.com/zoho/analytics-mcp-server
🔗
Integrations
https://github.com/zoho/analytics-dataiku-import-plugin
🔗
Integrations
https://github.com/zoho/analytics-dataiku-export-plugin
🔗
DeveloperPortal
https://www.bigin.com/developer-center.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zoho-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zoho-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zoho Settings API
  version: '1.0'
  description: 'Operations tagged Settings across 47 of this provider''s published API definitions: appointment_preference.json, assignment_rules.json, audit_log_export.json, business_hours.json, cadences.json, call_preferences.json, custom_views.json, data_sharing.json, duplicate_check_preference.json, email_templates.json, field_updates.json, fields.json, fiscal_year.json, from_addresses.json, global_picklists.json, inventory_templates.json, layouts.json, layouts_activate_deactivate.json, map_dependency.json…'
servers:
- url: https://zohoapis.{dc}/crm/{version}
  description: Public Zoho API Server URL for your account region.
  variables:
    dc:
      enum:
      - com
      - eu
      - in
      - cn
      - au
      default: com
      description: The data center domain (top-level domain) corresponding to the account's region.
    version:
      default: v8
      description: API Version
tags:


# --- truncated at 32 KB (2345 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/openapi/zoho-settings-api-openapi.yml