Zoho CRM

Zoho CRM Settings API

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

GitHub OpenAPI

Operations 213

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /settings/appointment_preferences Get appointment preferences · Retrieve Appointment Preferences #
Ask an LLM
“What are my current appointment preferences for deal creation and job sheets?”
“Can I see whether completing an appointment creates a deal automatically?”
Tell an agent
Show my appointment preferences.
Show my appointment preferences including {include}.
PUT /settings/appointment_preferences Update appointment preferences · Update Appointment Preferences #
Ask an LLM
“Can I change how appointments create deals when they are marked complete?”
“Is it possible to hide the job sheet on appointments through the API?”
Tell an agent
Update my appointment preferences to {appointment_preferences}.
Turn off automatic deal creation in my appointment preferences.
GET /settings/automation/assignment_rules List assignment rules · GET /settings/automation/assignment_rules #
Ask an LLM
“Which assignment rules are set up to route new records to owners?”
“Can I list only the assignment rules for the Leads module?”
Tell an agent
List all assignment rules.
List the assignment rules for the {module} module.
GET /settings/automation/assignment_rules/{id} Get an assignment rule · GET /settings/automation/assignment_rules/1234567890 #
Ask an LLM
“What criteria and owners does a specific assignment rule use?”
“Can I see the inner details of one assignment rule by its ID?”
Tell an agent
Show assignment rule {id} in the {module} module.
Get assignment rule {id} for {module} with inner details.
POST /settings/audit_log_export Start an audit log export · Create an Audit Log Export job #
Ask an LLM
“Can I export the audit log for a date range to review admin changes?”
“How do I start a job that exports audit logs matching certain criteria?”
Tell an agent
Start an audit log export with criteria {criteria}.
Export the audit log using {criteria} as the filter.
GET /settings/audit_log_export List audit log export jobs · Get Exported AuditLogs #
Ask an LLM
“What audit log exports have been run and are any still in progress?”
“Where can I find the download link for audit log exports I already requested?”
Tell an agent
List my audit log export jobs.
Show every audit log export and its status.
GET /settings/audit_log_export/{id} Get an audit log export job · Get Exported AuditLogs #
Ask an LLM
“Is a particular audit log export finished yet?”
“What is the status of the audit log export job I just created?”
Tell an agent
Check audit log export job {id}.
Get the download details for audit log export {id}.
POST /settings/business_hours Set up business hours · Create business hours configuration #
Ask an LLM
“How do I define business hours for an organization that has none configured yet?”
“Can I create a first business hours setup with working days and a timezone?”
Tell an agent
Create a business hours configuration of {business_hours}.
Set up new business hours for the org using {business_hours}.
PUT /settings/business_hours Update business hours · Update business hours configuration #
Ask an LLM
“Can I change our existing business hours to add Saturday as a working day?”
“Is it possible to switch the timezone on business hours we already set up?”
Tell an agent
Update our existing business hours to {business_hours}.
Change the business hours timezone and working days per {business_hours}.
GET /settings/business_hours Get business hours · Retrieve business hours configuration #
Ask an LLM
“What working days and hours is my CRM organization set to?”
“Which timezone do our configured business hours use?”
Tell an agent
Show our business hours configuration.
Get the organization's working days and hours.
GET /settings/automation/cadences List cadences · GET - Get all cadences #
Ask an LLM
“Which sales cadences are active right now?”
“Can I find a cadence by name within a module?”
Tell an agent
List all cadences.
List active cadences in {module}.
GET /settings/call_preferences Get call preferences · To get the Call preferences of the user #
Ask an LLM
“What from-number and to-number settings are used for my calls?”
“Where do I check my personal call preference in the CRM?”
Tell an agent
Show my call preferences.
Get the from and to number call settings for my user.
PUT /settings/call_preferences Update call preferences · Updating Call preference #
Ask an LLM
“Can I change which number shows as the from number on my calls?”
“Is it possible to update my user's call preference programmatically?”
Tell an agent
Update my call preferences to {call_preferences}.
Change my call from-number setting per {call_preferences}.
GET /settings/custom_views List a module's custom views · Get All Custom Views #
Ask an LLM
“What saved custom views exist for the Deals module?”
“Can I filter the list of custom views in a module?”
Tell an agent
List custom views for {module}.
List custom views in {module} matching {filters}.
GET /settings/custom_views/{id} Get a custom view · Get Custom View By Id #
Ask an LLM
“Which criteria and columns make up one specific custom view?”
“Can I fetch a single custom view by its ID?”
Tell an agent
Show custom view {id} in {module}.
Get custom view {id} of {module} with inner details.
PUT /settings/custom_views/actions/change_sort Change custom view sort order (ID in body) · Change Sort Order #
Ask an LLM
“Can I change the sort order of several custom views in one request?”
“Is there a way to set a view's sort field when the view ID is passed in the body?”
Tell an agent
Change the sort order of custom views in {module} to {custom_views}.
Re-sort {module} views using the body payload {custom_views}.
PUT /settings/custom_views/{id}/actions/change_sort Change one custom view's sort order · Change Sort Order #
Ask an LLM
“How do I change the sort column of one custom view by its ID in the URL?”
“Can I make a specific view sort by created time descending?”
Tell an agent
Change the sort order of custom view {id} in {module} to {custom_views}.
Sort view {id} of {module} per {custom_views}.
GET /settings/data_sharing Get data sharing settings · Get Data Sharing #
Ask an LLM
“What are the organization-wide data sharing permissions for each module?”
“Is the Contacts module set to private or public read/write?”
Tell an agent
Show our data sharing settings.
Get the default record access for every module.
PUT /settings/data_sharing Update data sharing settings · Update Data Sharing #
Ask an LLM
“Can I make a module private so only record owners and managers see it?”
“Is it possible to change default sharing rules for modules?”
Tell an agent
Update data sharing settings to {data_sharing}.
Change module access levels per {data_sharing}.
GET /settings/duplicate_check_preference Get duplicate check preference · Get Duplicate Check Preference #
Ask an LLM
“Which fields does a module use to detect duplicate records?”
“Is duplicate checking turned on for the Leads module?”
Tell an agent
Show the duplicate check preference for {module}.
Get duplicate detection settings of the {module} module.
POST /settings/duplicate_check_preference Create duplicate check preference · Create Duplicate Check Preference #
Ask an LLM
“How do I enable duplicate checking for a module that has none?”
“Can I set up a new duplicate rule that matches on email?”
Tell an agent
Create a duplicate check preference for {module} with {duplicate_check_preference}.
Turn on duplicate checking in {module} using {duplicate_check_preference}.
PUT /settings/duplicate_check_preference Update duplicate check preference · Update Duplicate Check Preference #
Ask an LLM
“Can I change which fields are compared when checking a module for duplicates?”
“Is it possible to adjust an existing duplicate check setup?”
Tell an agent
Update the duplicate check preference for {module} to {duplicate_check_preference}.
Change duplicate matching fields in {module} per {duplicate_check_preference}.
DELETE /settings/duplicate_check_preference Remove duplicate check preference · Delete Duplicate Check Preference #
Ask an LLM
“Can I switch off duplicate checking for a module entirely?”
“What happens if I remove the duplicate check preference from a module?”
Tell an agent destructive · confirm first
Delete the duplicate check preference for {module}.
Remove duplicate detection from the {module} module.
GET /settings/email_templates List email templates · Retrieve email templates list #
Ask an LLM
“Which email templates exist for the Leads module?”
“Can I sort email templates by last modified time and page through them?”
Tell an agent
List my email templates.
List email templates for {module} in category {category}.
GET /settings/automation/field_updates List field update actions · To retrieve all field updates #
Ask an LLM
“Which field update automation actions are configured?”
“Can I page through all field update actions sorted by name?”
Tell an agent
List all field update actions.
List field update actions sorted by {sort_by}.
POST /settings/automation/field_updates Create a field update action · To create a field update action #
Ask an LLM
“Can I create an action that sets a field value when a workflow fires?”
“How do I add a field update that blueprints or approvals can trigger?”
Tell an agent
Create a field update action {field_updates}.
Add a new field update automation with {field_updates}.
DELETE /settings/automation/field_updates Delete several field update actions · To delete multiple field update actions #
Ask an LLM
“Can I remove multiple field update actions at once?”
“Is there a bulk delete for field update automations?”
Tell an agent destructive · confirm first
Delete field update actions {ids}.
Remove the field updates with IDs {ids} in one go.
GET /settings/automation/field_updates/{id} Get a field update action · To retrieve a field update action by fieldUpdate ID #
Ask an LLM
“What field and value does a specific field update action set?”
“Can I see the full configuration of one field update by ID?”
Tell an agent
Show field update action {id}.
Get field update {id} with inner details {include_inner_details}.
PUT /settings/automation/field_updates/{id} Update a field update action · To update an existing field update action #
Ask an LLM
“Can I change the value an existing field update action writes?”
“Is it possible to rename a field update automation?”
Tell an agent
Update field update action {id} with {field_updates}.
Change the value set by field update {id} to {field_updates}.
DELETE /settings/automation/field_updates/{id} Delete a field update action · To delete a fieldupdate action #
Ask an LLM
“Can I delete one field update action I no longer use?”
“What happens to workflows when a single field update is removed?”
Tell an agent destructive · confirm first
Delete field update action {id}.
Remove the field update with ID {id}.
GET /settings/fields List a module's fields · Get Fields #
Ask an LLM
“What fields exist in the Contacts module and what are their data types?”
“Can I list only the unused fields of a module?”
Tell an agent
List the fields in {module}, including {include}.
List {type} fields in the {module} module with {include}.
POST /settings/fields Create custom fields · Create Fields #
Ask an LLM
“Can I add a new custom field to the Deals module?”
“How do I create several custom fields in a module at once?”
Tell an agent
Create custom fields {fields} in {module}.
Add a new custom field to {module}.
PATCH /settings/fields Update several custom fields · Update Fields #
Ask an LLM
“Can I update multiple custom fields in one request with IDs in the body?”
“Is there a bulk way to relabel custom fields in a module?”
Tell an agent
Update custom fields in {module} with {fields}.
Bulk-edit {module} custom fields using {fields}.
GET /settings/fields/{fieldId} Get one field's metadata · Get Field by ID #
Ask an LLM
“What are the properties of a specific field in a module?”
“Can I look up a single field's metadata by its field ID?”
Tell an agent
Show field {fieldId} in {module} including {include}.
Get the metadata of field {fieldId} from {module} with {include}.
PATCH /settings/fields/{fieldId} Update one custom field · Update Field by ID #
Ask an LLM
“Can I change the label or length of one custom field by its ID?”
“Is it possible to edit a single field's picklist options?”
Tell an agent
Update field {fieldId} in {module} with {fields}.
Rename custom field {fieldId} in {module}.
DELETE /settings/fields/{fieldId} Delete a custom field · Delete Custom Field #
Ask an LLM
“Can I delete a custom field that is no longer needed?”
“Why can't a custom field used in workflows or scoring rules be deleted?”
Tell an agent destructive · confirm first
Delete custom field {fieldId} from {module}.
Remove field {fieldId} in the {module} module.
GET /settings/fiscal_year Get fiscal year settings · GET /settings/fiscal_year #
Ask an LLM
“When does our organization's fiscal year start?”
“Is our CRM using a standard or custom fiscal year?”
Tell an agent
Show our fiscal year settings.
Get the fiscal year start month.
PUT /settings/fiscal_year Update fiscal year settings · PUT /settings/fiscal_year #
Ask an LLM
“Can an admin change the start month of the fiscal year?”
“Is it possible to switch our fiscal year to a custom one?”
Tell an agent
Update the fiscal year to {fiscal_year}.
Set the fiscal year start per {fiscal_year}.
GET /settings/emails/actions/from_addresses List from email addresses · Get From Addresses #
Ask an LLM
“Which email addresses am I allowed to send CRM emails from?”
“What sender addresses are available for outgoing email?”
Tell an agent
List my available from addresses.
Show the email addresses I can send from.
GET /settings/global_picklists List global picklists · Get all global picklists #
Ask an LLM
“What global picklists are shared across modules?”
“Can I see which modules use each global picklist?”
Tell an agent
List all global picklists.
List global picklists including {include}.
POST /settings/global_picklists Create a global picklist · Create a new global picklist #
Ask an LLM
“Can I create a picklist that several modules can reuse?”
“How do I define a new shared picklist with its values?”
Tell an agent
Create global picklist {global_picklists}.
Add a shared picklist defined as {global_picklists}.
GET /settings/global_picklists/{id} Get a global picklist · Get a single global picklist by id #
Ask an LLM
“What values does a particular global picklist contain?”
“How many fields use one specific global picklist?”
Tell an agent
Show global picklist {id}.
Get global picklist {id} including {include}.
PATCH /settings/global_picklists/{id} Update a global picklist · Update a global picklist by id #
Ask an LLM
“Can I add or rename values in an existing global picklist?”
“Is it possible to change a global picklist's display label?”
Tell an agent
Update global picklist {id} with {global_picklists}.
Add new values to global picklist {id}.
DELETE /settings/global_picklists/{id} Delete a global picklist · Delete a global picklist by id #
Ask an LLM
“Can I delete a global picklist and how long does removal take?”
“Is global picklist deletion asynchronous?”
Tell an agent destructive · confirm first
Delete global picklist {id}.
Remove the shared picklist with ID {id}.
GET /settings/global_picklists/{id}/actions/pick_list_values_associations See where a picklist value is used · Get picklist value associations #
Ask an LLM
“Which workflows or blueprints depend on a specific global picklist value?”
“Is a picklist value safe to remove, or is it used in automation?”
Tell an agent
Show where value {picklist_value_id} of global picklist {id} is used.
List features that reference picklist value {picklist_value_id} in {id}.
GET /settings/inventory_templates List inventory templates · Retrieve inventory templates list #
Ask an LLM
“Which inventory templates exist for quotes or invoices?”
“Can I filter inventory templates by category and sort them?”
Tell an agent
List my inventory templates.
List inventory templates for {module} sorted by {sort_by}.
POST /settings/layouts/{id}/actions/activate Activate a layout · Activate layout with profile associations #
Ask an LLM
“Can I reactivate a deactivated layout and assign it to profiles?”
“How do I turn a layout back on for a module?”
Tell an agent
Activate layout {id} in {module} with {layouts}.
Re-enable layout {id} of {module} for profiles in {layouts}.
DELETE /settings/layouts/{id}/actions/activate Deactivate a layout · Deactivate layout with configuration transfer #
Ask an LLM
“Can I deactivate a layout and move its profiles to another layout?”
“What happens to a layout's permissions when it is switched off?”
Tell an agent destructive · confirm first
Deactivate layout {id} in {module} and transfer to {transfer_to}.
Turn off layout {id} of {module}, moving its setup to layout {transfer_to}.
GET /settings/layouts List a module's layouts · Get all layouts metadata for a module #
Ask an LLM
“What layouts does the Deals module have?”
“Can I see the sections and fields of every layout in a module?”
Tell an agent
List layouts for {module}.
List {module} layouts in {mode} mode.
GET /settings/layouts/{id} Get a layout · Get a specific layout metadata by ID #
Ask an LLM
“What sections and fields are in one specific layout?”
“Can I fetch a single layout by its ID?”
Tell an agent
Show layout {id} of {module}.
Get layout {id} in {module} including {include}.
DELETE /settings/layouts/{id} Delete a custom layout · Delete a custom layout #
Ask an LLM
“Can I delete a custom layout that still has records?”
“Where do records go when their layout is deleted?”
Tell an agent destructive · confirm first
Delete layout {id} from {module}.
Delete layout {id} in {module} and move its records to {transfer_to}.
GET /settings/layouts/{layoutId}/map_dependency List field dependencies in a layout · Retrieve field dependencies for a layout #
Ask an LLM
“Which picklist fields depend on other fields in a layout?”
“Can I list all parent-child field dependencies for a layout?”
Tell an agent
List field dependencies for layout {layoutId} in {module}.
Show dependencies in layout {layoutId} of {module}, page {page}.
POST /settings/layouts/{layoutId}/map_dependency Create a field dependency · Create a new field dependency for a layout #
Ask an LLM
“Can I make a child picklist's options depend on a parent field?”
“How do I add a new field dependency to a layout?”
Tell an agent
Create field dependency {map_dependency} in layout {layoutId} of {module}.
Add a parent-child picklist mapping to layout {layoutId} in {module}.
GET /settings/layouts/{layoutId}/map_dependency/{dependencyId} Get a field dependency · Retrieve a specific field dependency by ID #
Ask an LLM
“Which child values map to each parent value in one field dependency?”
“Can I inspect a single field dependency by ID?”
Tell an agent
Show dependency {dependencyId} in layout {layoutId} of {module}.
Get the value mappings of dependency {dependencyId} on layout {layoutId} in {module}.
PUT /settings/layouts/{layoutId}/map_dependency/{dependencyId} Update a field dependency · Update an existing field dependency #
Ask an LLM
“Can I change which child picklist values a parent value allows?”
“Is it possible to remove one mapping from an existing field dependency?”
Tell an agent
Update dependency {dependencyId} in layout {layoutId} of {module} with {map_dependency}.
Change the picklist mappings of dependency {dependencyId} on layout {layoutId} in {module}.
DELETE /settings/layouts/{layoutId}/map_dependency/{dependencyId} Delete a field dependency · Delete a field dependency #
Ask an LLM
“Can I remove a field dependency so the child picklist shows all values?”
“Is deleting a field dependency permanent?”
Tell an agent destructive · confirm first
Delete dependency {dependencyId} from layout {layoutId} in {module}.
Remove the parent-child mapping {dependencyId} on layout {layoutId} of {module}.
POST /settings/tags/actions/mass_delete Mass delete tags · Schedule mass delete tags job #
Ask an LLM
“Can I delete many tags across several modules in one job?”
“Is there a bulk way to clean up unused tags?”
Tell an agent destructive · confirm first
Schedule a mass delete of tags {mass_delete}.
Delete these tags across modules: {mass_delete}.
GET /settings/tags/actions/mass_delete Check a tag mass-delete job · Get status of mass delete job #
Ask an LLM
“Has my scheduled tag mass-delete job finished?”
“What is the status of the bulk tag deletion I started?”
Tell an agent
Check the status of my tag mass delete job.
Show progress on the scheduled tag deletion.
GET /settings/modules List CRM modules · Retrieve CRM module metadata #
Ask an LLM
“Which modules are available in my CRM, including custom ones?”
“Can I list only modules that support a particular feature?”
Tell an agent
List all CRM modules.
List modules that support {feature_name}.
POST /settings/modules Create a custom module · Create a custom CRM module #
Ask an LLM
“Can I create a new custom module through the API?”
“What permission is needed to add a custom module?”
Tell an agent
Create custom module {modules}.
Add a new custom module defined as {modules}.
PUT /settings/modules Update several modules · Update CRM modules #
Ask an LLM
“Can I relabel multiple modules in a single request?”
“Is there a bulk way to change module profile assignments?”
Tell an agent
Update modules with {modules}.
Relabel several modules and their profiles per {modules}.
GET /settings/modules/{moduleIdentifier} Get a module's metadata · Get module metadata by API name #
Ask an LLM
“What configuration and fields does one module have?”
“Can I get a module's metadata by its API name?”
Tell an agent
Show metadata for module {moduleIdentifier}.
Get the configuration of the {moduleIdentifier} module.
PUT /settings/modules/{moduleIdentifier} Update one module's labels · Update module labels and profiles #
Ask an LLM
“Can I rename a single module's singular and plural labels?”
“Is it possible to change which profiles can access one module?”
Tell an agent
Update module {moduleIdentifier} with {modules}.
Rename the {moduleIdentifier} module labels.
GET /settings/fields/{fieldId}/pick_list_values Get a field's picklist values · Retrieve pick list values for a field #
Ask an LLM
“What options are available in a picklist field?”
“Can I see translated display values for a picklist field?”
Tell an agent
List picklist values of field {fieldId} in {module}.
Show the dropdown options for field {fieldId} of {module}.
GET /settings/pipeline List pipelines for a layout · Get Pipelines #
Ask an LLM
“Which deal pipelines are set up for a layout?”
“What stages does each pipeline in a layout include?”
Tell an agent
List pipelines for layout {layout_id}.
Show all sales pipelines on layout {layout_id}.
POST /settings/pipeline Create a pipeline · Create Pipeline #
Ask an LLM
“Can I add a new sales pipeline to a layout?”
“How do I create a pipeline with its own stages?”
Tell an agent
Create pipeline {pipeline} on layout {layout_id}.
Add a new pipeline to layout {layout_id}.
PATCH /settings/pipeline Update or delete pipelines (PATCH, IDs in body) · UpdateOrDelete Pipeline #
Ask an LLM
“Can I partially update several pipelines using PATCH?”
“Is there a bulk PATCH to delete pipelines from a layout?”
Tell an agent destructive · confirm first
Patch pipelines on layout {layout_id} with {pipeline}.
Partially update pipelines in bulk on layout {layout_id} via PATCH with {pipeline}.
PUT /settings/pipeline Update or delete pipelines (PUT, IDs in body) · UpdateOrDelete Pipeline #
Ask an LLM
“Can I update or delete several pipelines at once with a PUT request?”
“Is there a bulk PUT for changing pipelines on a layout?”
Tell an agent destructive · confirm first
Update pipelines on layout {layout_id} with PUT using {pipeline}.
Replace pipeline settings in bulk on layout {layout_id} via PUT with {pipeline}.
GET /settings/pipeline/{id} Get a pipeline · Get Pipeline #
Ask an LLM
“What stages are in one specific pipeline?”
“Can I fetch a single pipeline by its ID?”
Tell an agent
Show pipeline {id} on layout {layout_id}.
Get the stages of pipeline {id} in layout {layout_id}.
PATCH /settings/pipeline/{id} Update or delete one pipeline (PATCH by ID) · UpdateOrDelete Pipeline #
Ask an LLM
“Can I patch just the stages of one pipeline by its ID?”
“Is there a PATCH call to change a single pipeline's name?”
Tell an agent destructive · confirm first
Patch pipeline {id} on layout {layout_id} with {pipeline}.
Partially update pipeline {id} of layout {layout_id} via PATCH.
PUT /settings/pipeline/{id} Update or delete one pipeline (PUT by ID) · UpdateOrDelete Pipeline #
Ask an LLM
“Can I replace one pipeline's settings with a PUT on its ID?”
“Is there a PUT to delete a single pipeline by ID?”
Tell an agent destructive · confirm first
PUT update pipeline {id} on layout {layout_id} with {pipeline}.
Replace the settings of pipeline {id} in layout {layout_id} via PUT.
POST /settings/pipeline/actions/transfer Transfer deals and delete pipelines · Transfer and Delete Pipelines #
Ask an LLM
“Can I move deals to another pipeline before deleting the old one?”
“What happens to records when a pipeline is transferred and deleted?”
Tell an agent destructive · confirm first
Transfer and delete pipelines on layout {layout_id} per {transfer_pipeline}.
Move deals out and remove pipelines using {transfer_pipeline} on layout {layout_id}.
GET /settings/portals/{portal}/user_type List portal user types · List portal user types #
Ask an LLM
“What user types are defined for a customer portal?”
“Which kinds of portal users can I invite to my portal?”
Tell an agent
List user types for portal {portal}.
Show all user types in the {portal} portal.
POST /settings/portals/{portal}/user_type Create portal user types · Create portal user type #
Ask an LLM
“Can I add a new user type to a portal with its own permissions?”
“How do I create several portal user types at once?”
Tell an agent
Create user types {user_type} in portal {portal}.
Add a new user type to the {portal} portal.
GET /settings/portals/{portal}/user_type/{userTypeId} Get a portal user type · Get portal user type #
Ask an LLM
“What access does a particular portal user type have?”
“Can I fetch one portal user type by ID?”
Tell an agent
Show user type {userTypeId} in portal {portal}.
Get the permissions of portal user type {userTypeId} on {portal}.
PUT /settings/portals/{portal}/user_type/{userTypeId} Update a portal user type · Update portal user type #
Ask an LLM
“Can I change the module permissions of a portal user type?”
“Is it possible to rename an existing portal user type?”
Tell an agent
Update user type {userTypeId} in portal {portal} with {user_type}.
Rename portal user type {userTypeId} on {portal}.
DELETE /settings/portals/{portal}/user_type/{userTypeId} Delete a portal user type · Delete portal user type #
Ask an LLM
“Can I delete a portal user type I no longer need?”
“Is removing a portal user type permanent?”
Tell an agent destructive · confirm first
Delete user type {userTypeId} from portal {portal}.
Remove portal user type {userTypeId} on {portal}.
GET /settings/portals/{portal}/user_type/{userType}/users List portal users of a type · List portal users #
Ask an LLM
“Who are the users of a given type in my portal?”
“Can I filter portal users and page through them?”
Tell an agent
List users of type {userType} in portal {portal}.
List {userType} users on {portal} matching {filters}.
DELETE /settings/portals/{portal}/user_type/{userType}/users Remove portal users · delete portal users #
Ask an LLM
“Can I remove specific users from a portal user type?”
“Is there a bulk way to revoke portal users?”
Tell an agent destructive · confirm first
Delete portal users {personality_ids} of type {userType} from portal {portal}.
Remove all listed {userType} users from the {portal} portal.
POST /settings/portals/{portal}/user_type/{userType}/users/action/transfer Move portal users to another user type · Transfer portal users from one user group to another #
Ask an LLM
“Can I move portal users from one user group to another in the same portal?”
“How do I reassign portal users to a different user type?”
Tell an agent
Move users {personality_ids} from {userType} to {transfer_To} in portal {portal}.
Transfer portal users {personality_ids} on {portal} from type {userType} to {transfer_To}.
POST /settings/portals/{portal}/user_type/{userType}/users/{recordId}/actions/change_status Activate or deactivate a portal user · Change status of portal users #
Ask an LLM
“Can I deactivate a single portal user without deleting them?”
“How do I reactivate one portal user's access?”
Tell an agent
Set portal user {recordId} of type {userType} on {portal} to active {active}.
Deactivate portal user {recordId} in {portal} ({userType}) by setting active to {active}.
POST /settings/portals/{portal}/user_type/{userType}/users/actions/change_status Change status of many portal users · Change status of portal users in bulk #
Ask an LLM
“Can I activate or deactivate many portal users at once?”
“Is there a bulk status change for portal users?”
Tell an agent
Change status of {userType} users on portal {portal} per {change_status}.
Bulk deactivate portal users of type {userType} in {portal} using {change_status}.
GET /settings/portals List portals · Get portals #
Ask an LLM
“What customer portals does my organization have?”
“Which portals are set up for end customers?”
Tell an agent
List our portals.
Show all customer portals in the org.
POST /settings/portals Create a portal · Create portals #
Ask an LLM
“Can I create a portal so end customers can access their records?”
“How do I set up a new customer portal?”
Tell an agent
Create portal {portals}.
Set up a customer portal with {portals}.
GET /settings/portals/{portal} Get a portal · Get portal details #
Ask an LLM
“What are the settings of a specific portal?”
“Can I fetch one portal's details by name?”
Tell an agent
Show portal {portal}.
Get the settings of the {portal} portal.
PUT /settings/portals/{portal} Update a portal · Update portal #
Ask an LLM
“Can I change a portal's settings after it's created?”
“Is it possible to rename an existing portal?”
Tell an agent
Update portal {portal} with {portals}.
Change the settings of portal {portal}.
DELETE /settings/portals/{portal} Delete a portal · Delete portal #
Ask an LLM
“Can I delete a customer portal completely?”
“What happens to portal access when a portal is removed?”
Tell an agent destructive · confirm first
Delete portal {portal}.
Remove the {portal} portal.
GET /settings/profiles List CRM profiles · List CRM profiles #
Ask an LLM
“What permission profiles exist in my CRM?”
“Can I filter profiles by type?”
Tell an agent
List all CRM profiles.
List profiles of type {type}.
POST /settings/profiles/{id}/actions/clone Clone a profile · Clone a CRM profile #
Ask an LLM
“Can I copy an existing profile to start a new one?”
“How do I duplicate a permission profile under a new name?”
Tell an agent
Clone profile {id}.
Clone profile {id} as {profiles}.
PUT /settings/profiles/{id} Update a profile · Update a CRM profile #
Ask an LLM
“Can I change the permissions on an existing profile?”
“Is it possible to rename a profile?”
Tell an agent
Update profile {id} with {profiles}.
Change permissions of profile {id}.
GET /settings/profiles/{id} Get a profile · Get a CRM profile #
Ask an LLM
“What permissions does a specific profile grant?”
“Can I view one profile's details by ID?”
Tell an agent
Show profile {id}.
Get the permissions of profile {id}.
DELETE /settings/profiles/{id} Delete a profile · Delete a CRM profile #
Ask an LLM
“Can I delete a profile that users are still assigned to?”
“Where do users go when their profile is deleted?”
Tell an agent destructive · confirm first
Delete profile {id} and move its users to {transfer_to_id}.
Remove profile {id}, reassigning users to profile {transfer_to_id}.
POST /settings/record_locking_configurations Enable record locking for a module · Create Record Locking Configuration #
Ask an LLM
“Can I turn on record locking for a module that has none?”
“How do I add a record locking configuration?”
Tell an agent
Create record locking configuration {record_locking_configurations} for {module}.
Enable record locking in {module}.
PUT /settings/record_locking_configurations Update record locking (ID in body) · Update Record Locking Configuration #
Ask an LLM
“Can I update record locking settings for a module with the config ID in the body?”
“Is there a way to change several lock configurations in one request?”
Tell an agent
Update record locking in {module} with {record_locking_configurations}.
Change {module} lock rules in bulk per {record_locking_configurations}.
GET /settings/record_locking_configurations Get record locking configuration · Get Record Locking Configuration Details #
Ask an LLM
“Is record locking enabled for a module, and what triggers it?”
“Which record locking rules are configured for Deals?”
Tell an agent
Show record locking configuration for {module}.
Get the lock settings for the {module} module.
DELETE /settings/record_locking_configurations Delete record locking configs (by IDs) · Delete Record Locking Configuration #
Ask an LLM
“Can I delete several record locking configurations by listing their IDs?”
“Is there a bulk removal for record lock settings?”
Tell an agent destructive · confirm first
Delete record locking configurations {ids} in {module}.
Remove lock configs {ids} from the {module} module.
PUT /settings/record_locking_configurations/{id} Update one record locking config by ID · Update Record Locking Configuration by ID #
Ask an LLM
“Can I update a single lock configuration with its ID in the URL?”
“Is it possible to change the lock trigger of one specific configuration?”
Tell an agent
Update record locking configuration {id} in {module} with {record_locking_configurations}.
Change lock config {id} of {module}.
GET /settings/record_locking_configurations/{id} Get one record locking config by ID · Get Record Locking Configuration by ID #
Ask an LLM
“Can I fetch a single record locking configuration by its ID?”
“What does one particular lock configuration contain?”
Tell an agent
Show record locking configuration {id} in {module}.
Get lock config {id} for {module}.
DELETE /settings/record_locking_configurations/{id} Delete one record locking config by ID · Delete Record Locking Configuration by ID #
Ask an LLM
“Can I delete one record locking configuration using its ID in the URL?”
“What happens to locked records when their lock configuration is deleted?”
Tell an agent destructive · confirm first
Delete record locking configuration {id} in {module}.
Remove lock config {id} from {module}.
GET /settings/recycle_bin List recycle bin records · List recycle bin records #
Ask an LLM
“What records are sitting in the recycle bin?”
“Can I see deleted records before they are purged?”
Tell an agent
List records in the recycle bin.
Show what's been deleted recently.
DELETE /settings/recycle_bin Purge matching recycle bin records · Delete multiple recycle bin records #
Ask an LLM
“Can I permanently delete recycle bin records that match a filter?”
“Why would a recycle bin purge only partly succeed?”
Tell an agent destructive · confirm first
Permanently delete recycle bin records matching {filters}.
Purge recycle bin entries where {filters}.
POST /settings/recycle_bin/actions/restore Restore records from the recycle bin · Restore multiple recycle bin records #
Ask an LLM
“Can I restore several deleted records at once?”
“Is there a way to restore everything in the recycle bin?”
Tell an agent
Restore recycle bin records {ids}.
Restore deleted records matching {filters}.
GET /settings/recycle_bin/actions/count Count recycle bin records · Get recycle bin counts #
Ask an LLM
“How many records are in the recycle bin right now?”
“Can I get a quick total of deleted items?”
Tell an agent
Count the records in the recycle bin.
Give me the recycle bin totals.
POST /settings/recycle_bin/actions/empty Empty the recycle bin · Empty the recycle bin #
Ask an LLM
“Can I permanently clear the entire recycle bin?”
“Is emptying the recycle bin reversible?”
Tell an agent destructive · confirm first
Empty the recycle bin.
Permanently delete everything in the recycle bin.
POST /settings/recycle_bin/{recordId}/actions/restore Restore one deleted record · Restore a recycle bin record #
Ask an LLM
“Can I restore a single record I deleted by mistake?”
“How do I undo the deletion of one record?”
Tell an agent
Restore recycle bin record {recordId}.
Bring back deleted record {recordId}.
GET /settings/recycle_bin/{recordId} Get one recycle bin record · Get a recycle bin record #
Ask an LLM
“Who deleted a specific record and when?”
“Can I look up one entry in the recycle bin by ID?”
Tell an agent
Show recycle bin record {recordId}.
Get the deletion details of record {recordId}.
DELETE /settings/recycle_bin/{recordId} Permanently delete one bin record · Delete a recycle bin record #
Ask an LLM
“Can I purge a single record from the recycle bin for good?”
“Once a record is removed from the recycle bin, can it come back?”
Tell an agent destructive · confirm first
Permanently delete recycle bin record {recordId}.
Purge record {recordId} from the recycle bin.
GET /settings/related_lists Get related lists configuration · Retrieve related lists configuration #
Ask an LLM
“Which related lists appear on records in a module?”
“Can I see related lists for one specific layout?”
Tell an agent
List related lists for {module}.
Show related lists of {module} on layout {layout_id}.
GET /settings/roles List roles · Get all roles #
Ask an LLM
“What is our CRM role hierarchy?”
“Which roles exist in the organization?”
Tell an agent
List all roles.
Show the role hierarchy.
POST /settings/roles Create roles · Create new roles #
Ask an LLM
“Can I add a new role under an existing manager role?”
“How do I create several roles at once?”
Tell an agent
Create roles {roles}.
Add new roles to the hierarchy: {roles}.
PUT /settings/roles Update several roles · Update multiple roles #
Ask an LLM
“Can I update multiple roles in one call?”
“Is there a bulk way to change who roles report to?”
Tell an agent
Update roles with {roles}.
Bulk-edit role names and reporting lines per {roles}.
GET /settings/roles/{role} Get a role · Get specific role #
Ask an LLM
“Who does a specific role report to?”
“Can I fetch one role by its ID?”
Tell an agent
Show role {role}.
Get the details of role {role}.
PUT /settings/roles/{role} Update a role · Update role #
Ask an LLM
“Can I rename a single role or change its parent?”
“Is it possible to edit one role's sharing settings?”
Tell an agent
Update role {role} with {roles}.
Rename role {role}.
DELETE /settings/roles/{role} Delete a role · Delete role #
Ask an LLM
“Can I delete a role that still has users in it?”
“Where do users go when their role is deleted?”
Tell an agent destructive · confirm first
Delete role {role} and move users to {transfer_to_id}.
Remove role {role}, reassigning its users to role {transfer_to_id}.
GET /settings/automation/scoring_rules List scoring rules · GET /settings/automation/scoring_rules #
Ask an LLM
“Which lead scoring rules are configured?”
“Can I find scoring rules for a specific module or layout?”
Tell an agent
List all scoring rules.
List scoring rules for {module} on layout {layout_id}.
PUT /settings/automation/scoring_rules Update several scoring rules · PUT /settings/automation/scoring_rules #
Ask an LLM
“Can I update multiple scoring rules in one request?”
“Is there a bulk edit for scoring rule criteria?”
Tell an agent
Update scoring rules with {scoring_rules}.
Bulk-change scoring rules per {scoring_rules}.
POST /settings/automation/scoring_rules Create a scoring rule · POST /settings/automation/scoring_rules #
Ask an LLM
“Can I set up a scoring rule that adds points for certain field values?”
“How do I configure a new scoring rule for a module and layout?”
Tell an agent
Create scoring rule {scoring_rules}.
Add a new lead scoring rule defined as {scoring_rules}.
DELETE /settings/automation/scoring_rules Delete several scoring rules · DELETE /settings/automation/scoring_rules #
Ask an LLM
“Can I delete multiple scoring rules at once?”
“Is there a bulk removal for scoring rules?”
Tell an agent destructive · confirm first
Delete scoring rules {ids}.
Remove the scoring rules with IDs {ids}.
GET /settings/automation/scoring_rules/{ruleId} Get a scoring rule · GET /settings/automation/scoring_rules/{ruleId} #
Ask an LLM
“What field and touch-point rules make up one scoring rule?”
“Can I fetch a single scoring rule by ID?”
Tell an agent
Show scoring rule {ruleId}.
Get the criteria of scoring rule {ruleId}.
PUT /settings/automation/scoring_rules/{ruleId} Update a scoring rule · PUT /settings/automation/scoring_rules/{ruleId} #
Ask an LLM
“Can I change the field rules or touch-point rules of one scoring rule?”
“Is it possible to rename a single scoring rule?”
Tell an agent
Update scoring rule {ruleId} with {scoring_rules}.
Rename scoring rule {ruleId}.
DELETE /settings/automation/scoring_rules/{ruleId} Delete a scoring rule · DELETE /settings/automation/scoring_rules/{ruleId} #
Ask an LLM
“Can I delete one scoring rule I no longer use?”
“Is deleting a single scoring rule permanent?”
Tell an agent destructive · confirm first
Delete scoring rule {ruleId}.
Remove the scoring rule with ID {ruleId}.
PUT /settings/automation/scoring_rules/{ruleId}/actions/activate Activate a scoring rule · PUT /settings/automation/scoring_rules/{ruleId}/actions/activate #
Ask an LLM
“Can I switch on a scoring rule that is inactive?”
“How do I start a scoring rule applying scores?”
Tell an agent
Activate scoring rule {ruleId}.
Turn on scoring rule {ruleId}.
DELETE /settings/automation/scoring_rules/{ruleId}/actions/activate Deactivate a scoring rule · DELETE /settings/automation/scoring_rules/{ruleId}/actions/activate #
Ask an LLM
“Can I pause a scoring rule without deleting it?”
“Is there a way to switch off one scoring rule temporarily?”
Tell an agent destructive · confirm first
Deactivate scoring rule {ruleId}.
Turn off scoring rule {ruleId} but keep it.
POST /settings/automation/scoring_rules/{ruleId}/actions/clone Clone a scoring rule · POST /settings/automation/scoring_rules/{ruleId}/actions/clone #
Ask an LLM
“Can I copy an existing scoring rule as a starting point?”
“Is it possible to duplicate a scoring rule?”
Tell an agent
Clone scoring rule {ruleId}.
Make a copy of scoring rule {ruleId}.
GET /settings/service_preferences Get service preferences · Retrieve service preference settings for the organization #
Ask an LLM
“What service preference settings does the organization use?”
“Where can I check our org's service configuration?”
Tell an agent
Show our service preferences.
Get the organization's service preference settings.
PUT /settings/service_preferences Update service preferences · Update service preference settings for the organization #
Ask an LLM
“Can I change the organization's service preference settings?”
“Is it possible to update service configuration via the API?”
Tell an agent
Update service preferences to {service_preferences}.
Change our service settings per {service_preferences}.
GET /settings/business_hours/shift_hours List shift hours · Retrieve all shift hours #
Ask an LLM
“Which shifts are configured, and who works each one?”
“What break hours and holidays apply to each shift?”
Tell an agent
List all shift hours.
Show every shift with its users and holidays.
POST /settings/business_hours/shift_hours Create shifts · Create new shifts #
Ask an LLM
“Can I add a night shift with its own hours and timezone?”
“How do I create new shift hour configurations?”
Tell an agent
Create shifts {shift_hours}.
Add new shift hours defined as {shift_hours}.
PUT /settings/business_hours/shift_hours Update several shifts · Update multiple shift hours #
Ask an LLM
“Can I change the timing of multiple shifts at once?”
“Is there a bulk update for shift break hours?”
Tell an agent
Update shift hours with {shift_hours}.
Bulk-change shift timings per {shift_hours}.
GET /settings/business_hours/shift_hours/{shift} Get a shift · Retrieve a specific shift hour #
Ask an LLM
“What are the hours and breaks for one specific shift?”
“Which users are assigned to a given shift?”
Tell an agent
Show shift {shift}.
Get the timing and users of shift {shift}.
PUT /settings/business_hours/shift_hours/{shift} Update a shift · Update a specific shift hour #
Ask an LLM
“Can I change the hours of one particular shift?”
“Is it possible to update a single shift's timezone?”
Tell an agent
Update shift {shift} with {shift_hours}.
Change the break hours of shift {shift}.
DELETE /settings/business_hours/shift_hours/{shift} Delete a shift · Delete a specific shift hour #
Ask an LLM
“Can I delete a shift I no longer use?”
“Is removing a shift configuration permanent?”
Tell an agent destructive · confirm first
Delete shift {shift}.
Remove the shift hours with ID {shift}.
GET /settings/tags/{id}/actions/records_count Count records with a tag · GET /settings/tags/{id}/actions/records_count #
Ask an LLM
“How many records carry a particular tag?”
“Can I count tagged records within one module?”
Tell an agent
Count records tagged {id} in {module}.
Tell me how many {module} records use tag {id}.
POST /settings/tags/{id}/actions/merge Merge two tags · POST /settings/tags/{id}/actions/merge #
Ask an LLM
“Can I merge a duplicate tag into another one?”
“What happens to records when two tags are merged?”
Tell an agent destructive · confirm first
Merge tag {id} with {tags}.
Combine tag {id} into the tag in {tags}.
GET /settings/tags List tags in a module · this endpoint is used to get tags from a module #
Ask an LLM
“What tags are used in the Leads module?”
“Can I see which tags exist for a module and who created them?”
Tell an agent
List tags in {module}.
Show tags for {module} including {include}.
PUT /settings/tags Update tags (IDs in body) · PUT /settings/tags #
Ask an LLM
“Can I rename several tags at once by putting their IDs in the body?”
“Is there a bulk tag update for a module?”
Tell an agent
Update tags in {module} with {tags}.
Bulk-rename {module} tags per {tags}.
POST /settings/tags Create tags · POST /settings/tags #
Ask an LLM
“Can I create new tags for a module before applying them to records?”
“How do I add several tags to a module?”
Tell an agent
Create tags {tags} in {module}.
Add new tags to the {module} module.
PUT /settings/tags/{id} Update one tag · PUT /settings/tags/{id} #
Ask an LLM
“Can I rename or recolor one specific tag?”
“Is it possible to edit a single tag by ID?”
Tell an agent
Update tag {id} with {tags}.
Rename the tag with ID {id}.
DELETE /settings/tags/{id} Delete a tag · DELETE /settings/tags/{id} #
Ask an LLM
“Can I delete a single tag I no longer use?”
“Does deleting a tag remove it from tagged records?”
Tell an agent destructive · confirm first
Delete tag {id}.
Remove the tag with ID {id}.
GET /settings/territories List territories · Get all territories #
Ask an LLM
“What sales territories are defined in my CRM?”
“Can I filter and page through territories?”
Tell an agent
List all territories.
List territories {ids}.
POST /settings/territories Create territories · Create Territories #
Ask an LLM
“Can I set up new sales territories under a parent territory?”
“How do I create territories with assignment criteria?”
Tell an agent
Create territories {territories}.
Add new territories defined as {territories}.
PUT /settings/territories Update several territories · Update Territory #
Ask an LLM
“Can I update multiple territories in one request?”
“Is there a bulk edit for territory managers or criteria?”
Tell an agent
Update territories with {territories}.
Bulk-change territory settings per {territories}.
DELETE /settings/territories Delete several territories · Delete Territories #
Ask an LLM
“Can I delete multiple territories at once?”
“Is it possible to delete past forecasts along with the territories?”
Tell an agent destructive · confirm first
Delete territories {ids}.
Delete territories {ids} and their previous forecasts: {delete_previous_forecasts}.
GET /settings/territories/{id} Get a territory · Get Territory #
Ask an LLM
“Who manages a specific territory and what are its criteria?”
“Can I fetch one territory by ID?”
Tell an agent
Show territory {id}.
Get territory {id} with inner details.
PUT /settings/territories/{id} Update one territory · Update Territory #
Ask an LLM
“Can I change the manager of one territory?”
“Is it possible to edit a single territory's criteria by ID?”
Tell an agent
Update territory {id} with {territories}.
Change the manager of territory {id}.
DELETE /settings/territories/{id} Delete one territory · Delete Territory By Id #
Ask an LLM
“Can I delete one territory and its old forecasts?”
“What happens to forecasts when a single territory is deleted?”
Tell an agent destructive · confirm first
Delete territory {id}.
Delete territory {id} with previous forecasts set to {delete_previous_forecasts}.
POST /settings/territories/actions/transfer_and_delete Transfer and delete territories · Transfer And Delete Territories #
Ask an LLM
“Can I move records to another territory before deleting several territories?”
“Is there a bulk transfer-and-delete for territories?”
Tell an agent destructive · confirm first
Transfer and delete territories per {territories}.
Move records out of and remove the territories in {territories}.
POST /settings/territories/{id}/actions/transfer_and_delete Transfer and delete one territory · Transfer And Delete Territory By Id #
Ask an LLM
“Can I hand one territory's records to another territory and then delete it?”
“How do I retire a single territory without losing its records?”
Tell an agent destructive · confirm first
Transfer and delete territory {id} per {territories}.
Retire territory {id}, moving its records to another territory.
GET /settings/territories/{id}/__child_territories List child territories · Get Child Territories By Id #
Ask an LLM
“Which territories sit beneath a given parent territory?”
“Can I see the sub-territories of one territory?”
Tell an agent
List child territories of {id}.
Show sub-territories under {id} matching {filters}.
GET /settings/territories/actions/associated_users_count Count users per territory · Get Associated Users Count #
Ask an LLM
“How many users are assigned to each territory?”
“Can I get territory membership counts in one call?”
Tell an agent
Count users associated with each territory.
Show the number of users in every territory.
GET /settings/territories/{territory}/users List users in a territory · List territory users #
Ask an LLM
“Which users belong to a specific territory?”
“Who is assigned to the West Coast territory?”
Tell an agent
List users in territory {territory}.
Show members of territory {territory}.
PUT /settings/territories/{territory}/users Add users to a territory · Add users #
Ask an LLM
“Can I add several users to a territory at once?”
“How do I assign reps to a territory?”
Tell an agent
Add users {users} to territory {territory}.
Assign these reps to territory {territory}: {users}.
DELETE /settings/territories/{territory}/users Remove users from a territory · Remove users #
Ask an LLM
“Can I remove several users from a territory in one call?”
“Is there a bulk way to unassign reps from a territory?”
Tell an agent destructive · confirm first
Remove users {ids} from territory {territory}.
Unassign users {ids} from territory {territory}.
GET /settings/territories/{territory}/users/{user} Get a user in a territory · Get user details #
Ask an LLM
“Is a particular user part of a given territory?”
“Can I see one user's membership details in a territory?”
Tell an agent
Show user {user} in territory {territory}.
Check whether user {user} belongs to territory {territory}.
PUT /settings/territories/{territory}/users/{user} Add one user to a territory · Add specific user #
Ask an LLM
“Can I add a single rep to a territory?”
“How do I put one specific user into a territory?”
Tell an agent
Add user {user} to territory {territory}.
Assign rep {user} to territory {territory}.
DELETE /settings/territories/{territory}/users/{user} Remove one user from a territory · Remove user #
Ask an LLM
“Can I take one specific user out of a territory?”
“What happens when a single rep is removed from a territory?”
Tell an agent destructive · confirm first
Remove user {user} from territory {territory}.
Unassign rep {user} from territory {territory}.
GET /settings/unsubscribe_links/{id} Get an unsubscribe link · GET /settings/unsubscribe_links/111111000000115718 #
Ask an LLM
“What page does a specific unsubscribe link point to?”
“Can I fetch one unsubscribe link by ID?”
Tell an agent
Show unsubscribe link {id}.
Get the details of opt-out link {id}.
PUT /settings/unsubscribe_links/{id} Update one unsubscribe link · PUT /settings/unsubscribe_links/111111000000115722 #
Ask an LLM
“Can I edit a single unsubscribe link using its ID in the URL?”
“Is it possible to change the landing page of one opt-out link?”
Tell an agent
Update unsubscribe link {id} with {unsubscribe_links}.
Change the landing page of opt-out link {id}.
DELETE /settings/unsubscribe_links/{id} Delete an unsubscribe link · DELETE /settings/unsubscribe_links/111111000000115722 #
Ask an LLM
“Can I delete an unsubscribe link I no longer use?”
“Is removing an opt-out link permanent?”
Tell an agent destructive · confirm first
Delete unsubscribe link {id}.
Remove opt-out link {id}.
GET /settings/unsubscribe_link/actions/associations See where unsubscribe links are used · GET /settings/unsubscribe_link/actions/associations #
Ask an LLM
“Which email templates or campaigns use our unsubscribe links?”
“Is an unsubscribe link safe to delete, or is it still associated somewhere?”
Tell an agent
Show where unsubscribe links are associated.
List the usages of our opt-out links.
GET /settings/user_groups List user groups · Get Groups #
Ask an LLM
“What user groups exist in my organization?”
“Can I filter and page through user groups?”
Tell an agent
List all user groups.
List user groups matching {filters}.
POST /settings/user_groups Create a user group · Create Group #
Ask an LLM
“Can I create a group of users for sharing rules or workflows?”
“How do I add a new user group with its members?”
Tell an agent
Create user group {user_groups}.
Add a new user group defined as {user_groups}.
GET /settings/user_groups/{group} Get a user group · Get Group #
Ask an LLM
“What is the description and setup of one user group?”
“Can I fetch a single user group by ID?”
Tell an agent
Show user group {group}.
Get the details of user group {group}.
PUT /settings/user_groups/{group} Update a user group · Update Group #
Ask an LLM
“Can I rename a user group or change its members?”
“Is it possible to edit an existing user group?”
Tell an agent
Update user group {group} with {user_groups}.
Rename user group {group}.
DELETE /settings/user_groups/{group} Delete a user group · Delete Group #
Ask an LLM
“Can I delete a user group that's no longer needed?”
“Is deleting a user group permanent?”
Tell an agent destructive · confirm first
Delete user group {group}.
Remove the user group with ID {group}.
GET /settings/user_groups/{group}/sources List a user group's members · Get Sources #
Ask an LLM
“Which users, roles and territories make up a user group?”
“Can I page through the members of one group?”
Tell an agent
List members of user group {group}.
Show sources in group {group}, page {page}.
GET /settings/user_groups/{group}/actions/sources_count Count a user group's sources · Get Sources Count #
Ask an LLM
“How many territories, roles, groups and users are in a user group?”
“Can I get a member breakdown count for one group?”
Tell an agent
Count the sources in user group {group}.
Give me the member counts by type for group {group}.
GET /settings/user_groups/actions/associated_users_count Count users across user groups · Get Associated Users Count #
Ask an LLM
“How many users belong to each user group?”
“Can I filter the user counts across groups?”
Tell an agent
Count users associated with user groups.
Count users in user groups matching {filters}.
GET /settings/user_groups/{group}/actions/associations See where a user group is used · Get Group associations #
Ask an LLM
“Which sharing rules or workflows reference a specific user group?”
“Is a user group used in approvals or assignment rules?”
Tell an agent
Show associations of user group {group}.
List the rules and processes that use group {group}.
GET /settings/variable_groups List variable groups · GET /settings/variable_groups #
Ask an LLM
“What variable groups have been created in the org?”
“Which groups organize our CRM variables?”
Tell an agent
List all variable groups.
Show our CRM variable groups.
PUT /settings/variable_groups Update variable groups (IDs in body) · PUT variable_groups #
Ask an LLM
“Can I update several variable groups in one request?”
“Is there a bulk rename for variable groups?”
Tell an agent
Update variable groups with {variable_groups}.
Bulk-edit variable group details per {variable_groups}.
GET /settings/variable_groups/{id} Get a variable group · GET variable_groups by {id} #
Ask an LLM
“What are the details of one variable group?”
“Can I fetch a single variable group by ID?”
Tell an agent
Show variable group {id}.
Get the details of variable group {id}.
PUT /settings/variable_groups/{id} Update one variable group · PUT by variable_groups by id #
Ask an LLM
“Can I rename one variable group by ID?”
“Is it possible to change a single variable group's description?”
Tell an agent
Update variable group {id} with {variable_groups}.
Rename variable group {id}.
GET /settings/variables List variables · GET /settings/variables #
Ask an LLM
“What org variables are defined for use in functions and templates?”
“Which CRM variables exist and what are their values?”
Tell an agent
List all variables.
Show every org variable and its value.
PUT /settings/variables Update several variables · PUT /settings/variables #
Ask an LLM
“Can I update multiple variable values at once?”
“Is there a bulk edit for org variables?”
Tell an agent
Update variables with {variables}.
Bulk-change variable values per {variables}.
POST /settings/variables Create variables · POST /settings/variables #
Ask an LLM
“Can I create a new org variable for an API key or constant?”
“How do I add variables to a variable group?”
Tell an agent
Create variables {variables}.
Add new org variables defined as {variables}.
DELETE /settings/variables Delete several variables · DELETE /settings/variables #
Ask an LLM
“Can I delete multiple variables at once?”
“Is there a bulk removal for org variables?”
Tell an agent destructive · confirm first
Delete variables {ids}.
Remove the variables with IDs {ids}.
GET /settings/variables/{id} Get a variable · GET /settings/variables/1234567890 #
Ask an LLM
“What is the current value of one specific variable?”
“Can I look up a variable by ID within its group?”
Tell an agent
Show variable {id}.
Get variable {id} in group {group}.
PUT /settings/variables/{id} Update a variable · PUT /settings/variables/1234567890 #
Ask an LLM
“Can I change the value of one variable?”
“Is it possible to update a single org variable by ID?”
Tell an agent
Update variable {id} with {variables}.
Change the value of variable {id}.
DELETE /settings/variables/{id} Delete a variable · DELETE /settings/variables/1234567890 #
Ask an LLM
“Can I delete one variable I no longer need?”
“What breaks if a single org variable is removed?”
Tell an agent destructive · confirm first
Delete variable {id}.
Remove the variable with ID {id}.
GET /settings/automation/webhooks List webhooks · GET /settings/automation/webhooks #
Ask an LLM
“Which webhooks are configured in my CRM?”
“Can I list webhooks for one module sorted by name?”
Tell an agent
List all webhooks.
List webhooks for {module}.
PUT /settings/automation/webhooks Update webhooks (IDs in body) · PUT /settings/automation/webhooks #
Ask an LLM
“Can I update several webhooks in one call with their IDs in the body?”
“Is there a bulk edit for webhook URLs?”
Tell an agent
Update webhooks with {webhooks}.
Bulk-change webhook settings per {webhooks}.
POST /settings/automation/webhooks Create a webhook · POST /settings/automation/webhooks #
Ask an LLM
“Can I send CRM data to an external service when a record changes?”
“How do I set up a new webhook to post to my URL?”
Tell an agent
Create webhook {webhooks}.
Add a webhook that posts to my service, defined as {webhooks}.
DELETE /settings/automation/webhooks Delete several webhooks · DELETE /settings/automation/webhooks #
Ask an LLM
“Can I delete multiple webhooks at once?”
“What's the maximum number of webhooks I can delete per call?”
Tell an agent destructive · confirm first
Delete webhooks {ids}.
Remove up to ten webhooks: {ids}.
GET /settings/automation/webhooks/{webhookId} Get a webhook · GET /settings/automation/webhooks/{webhookId} #
Ask an LLM
“What URL and payload does one webhook send?”
“Can I fetch a single webhook's configuration by ID?”
Tell an agent
Show webhook {webhookId}.
Get the configuration of webhook {webhookId}.
PUT /settings/automation/webhooks/{webhookId} Update one webhook · PUT /settings/automation/webhooks #
Ask an LLM
“Can I change the URL of one specific webhook?”
“Is it possible to edit a single webhook's parameters by ID?”
Tell an agent
Update webhook {webhookId} with {webhooks}.
Change the target URL of webhook {webhookId}.
DELETE /settings/automation/webhooks/{webhookId} Delete a webhook · DELETE /settings/automation/webhooks/{webhookId} #
Ask an LLM
“Can I delete one webhook I no longer need?”
“Is deleting a single webhook permanent?”
Tell an agent destructive · confirm first
Delete webhook {webhookId}.
Remove the webhook with ID {webhookId}.
GET /settings/automation/webhook_failures List webhook failures · GET /settings/automation/webhook_failures #
Ask an LLM
“Why are my webhooks failing, and when did they fail?”
“Can I see failures for one webhook within a date range?”
Tell an agent
List webhook failures.
Show failures for webhook {webhook_id} from {from} to {to}.
GET /settings/automation/webhooks/actions/associated_modules List modules using webhooks · GET /settings/automation/webhooks/actions/associated_modules #
Ask an LLM
“Which modules have webhook actions associated with them?”
“What modules currently fire webhooks?”
Tell an agent
List modules associated with webhooks.
Show which modules use webhook actions.
GET /settings/automation/webhooks/actions/usage_reports Get webhook usage report · GET /settings/automation/webhooks/actions/usage_reports #
Ask an LLM
“How many webhook calls ran over the last seven days?”
“Can I break down webhook usage by module or date?”
Tell an agent
Show webhook usage grouped by {group_by}.
Get webhook usage grouped by {group_by} from {from} to {to}.
GET /settings/wizards List wizards · Get all wizards with basic details #
Ask an LLM
“What wizards are set up for guided record creation?”
“Can I list only the wizards for one module?”
Tell an agent
List all wizards.
List wizards for {module}.
POST /settings/automation/workflow_rules Create a workflow rule · Configure a Workflow rule #
Ask an LLM
“Can I set up a workflow that sends an email when a deal is won?”
“How do I configure a new workflow rule with actions?”
Tell an agent
Create workflow rule {workflow_rules}.
Configure a new workflow defined as {workflow_rules}.
PUT /settings/automation/workflow_rules Update workflow rules (ID in body) · Update Workflow Rule For the Given ID in Body #
Ask an LLM
“Can I update a workflow rule by passing its ID in the request body?”
“Is there a bulk partial update for workflow rules?”
Tell an agent
Update workflow rules with {workflow_rules}.
Patch several workflows at once using {workflow_rules}.
GET /settings/automation/workflow_rules List workflow rules · Get All WorkflowRules #
Ask an LLM
“Which workflow rules are active in a module?”
“Can I filter workflow rules by when they execute?”
Tell an agent
List all workflow rules.
List workflow rules in {module} that run on {execute_on}.
DELETE /settings/automation/workflow_rules Delete several workflow rules · Delete Multiple Workflow Rules #
Ask an LLM
“Can I delete multiple workflow rules at once?”
“Is there a bulk removal for workflows?”
Tell an agent destructive · confirm first
Delete workflow rules {ids}.
Remove the workflows with IDs {ids}.
PUT /settings/automation/workflow_rules/{id} Update one workflow rule · Update Workflow Rule By ID #
Ask an LLM
“Can I change the criteria of one workflow using its ID in the URL?”
“Is it possible to deactivate a single workflow rule?”
Tell an agent
Update workflow rule {id} with {workflow_rules}.
Deactivate workflow {id}.
GET /settings/automation/workflow_rules/{id} Get a workflow rule · Retrieve a single workflow #
Ask an LLM
“What criteria and actions does one workflow rule have?”
“Can I fetch a single workflow by ID?”
Tell an agent
Show workflow rule {id}.
Get the actions of workflow {id}.
DELETE /settings/automation/workflow_rules/{id} Delete a workflow rule · Delete Workflow Rule By ID #
Ask an LLM
“Can I delete one workflow rule I no longer use?”
“Is deleting a single workflow permanent?”
Tell an agent destructive · confirm first
Delete workflow rule {id}.
Remove the workflow with ID {id}.
GET /settings/automation/workflow_rules/actions/actions_count Count actions in workflow rules · Get Workflow Rule actions count #
Ask an LLM
“How many instant and scheduled actions do my workflows have?”
“Can I count actions for a specific set of workflow rules?”
Tell an agent
Count actions in workflow rules {ids}.
Show instant and scheduled action totals for workflows {ids}.
GET /settings/automation/workflow_rules/actions/module_specific_count Count workflow actions per module · Get Workflow Rule actions count for each module #
Ask an LLM
“How many workflow actions does each module have?”
“Which module has the most workflow actions configured?”
Tell an agent
Count workflow actions for each module.
Count workflow actions in {module}.
GET /settings/automation/workflow_rules/actions/rules_count Get workflow rule limits and usage · Get Workflow Rules count #
Ask an LLM
“How close am I to my workflow rule limit?”
“What is the allowed number of workflow rules and actions on my plan?”
Tell an agent
Show my workflow rule limits and usage.
Check how many workflow rules I've used versus my limit.
GET /settings/automation/workflow_rules/{workflowRuleId}/actions/usage Get a workflow rule's execution usage · To retrieve Workflow Rule usage #
Ask an LLM
“How many times did a particular workflow run last month?”
“Can I see a usage report for one workflow over a date range?”
Tell an agent
Show usage of workflow {workflowRuleId} from {executed_from} to {executed_till}.
Count executions of workflow {workflowRuleId} between {executed_from} and {executed_till}.
PUT /settings/automation/workflow_rules/actions/reorder Reorder workflow rules · To reorder workflow rules #
Ask an LLM
“Can I change the order in which workflow rules run?”
“Why do workflows execute in creation order, and can I override it?”
Tell an agent
Reorder workflow rules as {reorder}.
Set the execution order of {module} workflows to {reorder}.
GET /settings/automation/tasks List automation tasks · GET /settings/automation/tasks #
Ask an LLM
“Which automation task actions are configured for workflows?”
“Can I list automation tasks for one module?”
Tell an agent
List automation tasks.
List automation tasks for {module}.
POST /settings/automation/tasks Create an automation task · POST /settings/automation/tasks #
Ask an LLM
“Can I create a task action that workflows assign automatically?”
“How do I add a new automation task?”
Tell an agent
Create automation task {tasks}.
Add a workflow task action defined as {tasks}.
DELETE /settings/automation/tasks Delete several automation tasks · DELETE /settings/automation/tasks #
Ask an LLM
“Can I delete multiple automation tasks at once?”
“Is there a bulk removal for workflow task actions?”
Tell an agent destructive · confirm first
Delete automation tasks {ids}.
Remove the automation tasks with IDs {ids}.
GET /settings/automation/tasks/{id} Get an automation task · GET /settings/automation/tasks/{id} #
Ask an LLM
“What subject and due date does one automation task set?”
“Can I fetch a single automation task by ID?”
Tell an agent
Show automation task {id}.
Get automation task {id} with inner details.
PUT /settings/automation/tasks/{id} Update an automation task · PUT /settings/automation/tasks/123445566 #
Ask an LLM
“Can I change the subject or due date of one automation task?”
“Is it possible to edit a single workflow task action?”
Tell an agent
Update automation task {id} with {tasks}.
Change the due date of automation task {id}.
DELETE /settings/automation/tasks/{id} Delete an automation task · DELETE /settings/automation/tasks/{id} #
Ask an LLM
“Can I delete one automation task I no longer use?”
“Is deleting a single automation task permanent?”
Tell an agent destructive · confirm first
Delete automation task {id}.
Remove the automation task with ID {id}.
GET /settings/zia/data_enrichment Get Zia data enrichment settings · get Zia Enrichment Configuration for a specific module #
Ask an LLM
“Is Zia data enrichment configured for our modules?”
“Which fields does Zia enrichment fill in?”
Tell an agent
Show the Zia data enrichment configuration.
Get our Zia enrichment settings.

Documentation

📖
Documentation
https://www.zoho.com/crm/developer/docs/api/v2/notifications/
📖
Documentation
https://www.zoho.com/crm/developer/docs/api/v8/
📖
APIReference
https://www.zoho.com/crm/developer/docs/api/v8/list-available-rest-apis.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/zoho-crm/openapi/zoho-crm-settings-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/zoho-crm/asyncapi/zoho-crm-notifications-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/zoho-crm/json-schema/zoho-crm-field-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/zoho-crm/json-schema/zoho-crm-field-request-body-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/zoho-crm/json-schema/zoho-crm-field-update-request-body-schema-schema.json
📊
JSONSchema
https://artifacts.apis.io/zoho-crm/json-schema/zoho-crm-user-schema.json
📊
JSONSchema
https://artifacts.apis.io/zoho-crm/json-schema/zoho-crm-territory-getschema-schema.json
📊
JSONSchema
https://artifacts.apis.io/zoho-crm/json-schema/zoho-crm-related-list-schema.json

Other Resources

🔗
Webhooks
https://artifacts.apis.io/zoho-crm/asyncapi/zoho-crm-notifications-asyncapi.yml
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/apis.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/appointment_preference.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/appointments.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/assignment_rules.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/associate_email.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/attachments.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/audit_log_export.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/available_currencies.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/bulk_read.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/bulk_write.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/business_hours.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/cadences_execution.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/cadences.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/call_preferences.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/cancel_meetings.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/change_owner.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/composite_requests.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/contact_roles.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/conversion_option.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/convert.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/coql.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/currencies.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/custom_views.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/data_sharing.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/deal_contact_roles.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/deal_link_emails.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/download_attachments.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/download_inline_images.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/duplicate_check_preference.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/email_drafts.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/email_templates.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/emails_sharing_details.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/features.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/fetch_full_data.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/field_updates.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/fields.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/files.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/find_and_merge.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/fiscal_year.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/from_addresses.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/get_related_records_count.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/global_picklists.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/holidays.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/inventory_convert.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/inventory_templates.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/layouts_activate_deactivate.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/layouts.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/locking_informations.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/mail_merge.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/map_dependency.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/mass_change_owner.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/mass_convert.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/mass_delete_cvid.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/mass_delete_tags.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/mass_update.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/module_search.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/modules.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/notes.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/notifications.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/org.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/org_photo.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/ownership_history.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/pick_list_values.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/pipeline.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/portal_user_type.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/portal_users.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/portals.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/profiles.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/record_count.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/record_locking_configurations.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/record.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/record_photo.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/record_share_email.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/recycle_bin.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/related_lists.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/related_notes.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/related_records.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/roles.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/scoring_rules.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/send_mail.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/service_preference.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/services.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/share_records.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/shift_hours.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/tags_actions.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/tags.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/territories.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/territory_users.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/timelines.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/unblock_email.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/unsubscribe_links.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/upload.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/user_groups.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/users.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/users_territories.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/users_transfer.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/variable_groups.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/variables.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/webhooks.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/wizards.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/workflow_configurations.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/workflow_rules.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/workflow_tasks.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/zia_enrichment.json
🔗
SourceCode
https://github.com/zoho/crm-oas/blob/main/v8.0/zia_org_enrichment.json

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-crm:zoho-crm-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-crm-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zoho Crm Settings API
  version: '1.0'
  description: 'Operations tagged Settings across 47 of this provider''s published API definitions: zoho-crm-appointment-preference-openapi.json, zoho-crm-assignment-rules-openapi.json, zoho-crm-audit-log-export-openapi.json, zoho-crm-business-hours-openapi.json, zoho-crm-cadences-openapi.json, zoho-crm-call-preferences-openapi.json, zoho-crm-custom-views-openapi.json, zoho-crm-data-sharing-openapi.json, zoho-crm-duplicate-check-preference-openapi.json, zoho-crm-email-templates-openapi.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 (2346 KB total) ---
# Full source: https://artifacts.apis.io/zoho-crm/openapi/zoho-crm-settings-api-openapi.yml