Zoho Settings API
The Settings API from Zoho — 107 operation(s) for settings.
Zoho Settings API is one of 205 APIs that Zoho publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Settings. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and code examples.
This API exposes 213 operations across 107 paths, and defines 755 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
213 operations
107 paths
755 schemas
36 DELETE89 GET5 PATCH37 POST46 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoho Settings API declares
1 security scheme
for authenticating requests.
It defines a custom scheme (iam-oauth2-schema).
Paths & Operations 213
Across 107 paths, the API surfaces 213 operations — 36 DELETE, 89 GET, 5 PATCH, 37 POST, 46 PUT. Each is listed below with its method, path, parameters, and response codes.
Settings 213
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/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/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/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/variable_groups
GET /settings/variablegroups
PUT
/settings/variable_groups
PUT variablegroups
GET
/settings/variable_groups/{id}
GET variablegroups by {id}
PUT
/settings/variable_groups/{id}
PUT by variablegroups by id
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/email_templates
Retrieve email templates list
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/webhookfailures
GET
/settings/automation/webhooks/actions/associated_modules
GET /settings/automation/webhooks/actions/associatedmodules
GET
/settings/automation/webhooks/actions/usage_reports
GET /settings/automation/webhooks/actions/usagereports
GET
/settings/related_lists
Retrieve related lists configuration
POST
/settings/business_hours
Create business hours configuration
PUT
/settings/business_hours
Update business hours configuration
GET
/settings/business_hours
Retrieve business hours configuration
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/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/service_preferences
Retrieve service preference settings for the organization
PUT
/settings/service_preferences
Update service preference settings for the organization
GET
/settings/automation/scoring_rules
GET /settings/automation/scoringrules
PUT
/settings/automation/scoring_rules
PUT /settings/automation/scoringrules
POST
/settings/automation/scoring_rules
POST /settings/automation/scoringrules
DELETE
/settings/automation/scoring_rules
DELETE /settings/automation/scoringrules
GET
/settings/automation/scoring_rules/{ruleId}
GET /settings/automation/scoringrules/{ruleId}
PUT
/settings/automation/scoring_rules/{ruleId}
PUT /settings/automation/scoringrules/{ruleId}
DELETE
/settings/automation/scoring_rules/{ruleId}
DELETE /settings/automation/scoringrules/{ruleId}
PUT
/settings/automation/scoring_rules/{ruleId}/actions/activate
PUT /settings/automation/scoringrules/{ruleId}/actions/activate
DELETE
/settings/automation/scoring_rules/{ruleId}/actions/activate
DELETE /settings/automation/scoringrules/{ruleId}/actions/activate
POST
/settings/automation/scoring_rules/{ruleId}/actions/clone
POST /settings/automation/scoringrules/{ruleId}/actions/clone
POST
/settings/layouts/{id}/actions/activate
Activate layout with profile associations
DELETE
/settings/layouts/{id}/actions/activate
Deactivate layout with configuration transfer
GET
/settings/automation/assignment_rules
GET /settings/automation/assignmentrules
GET
/settings/automation/assignment_rules/{id}
GET /settings/automation/assignmentrules/1234567890
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
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/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/inventory_templates
Retrieve inventory templates list
GET
/settings/wizards
Get all wizards with basic details
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/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/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/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
GET
/settings/call_preferences
To get the Call preferences of the user
PUT
/settings/call_preferences
Updating Call preference
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/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/fiscal_year
GET /settings/fiscalyear
PUT
/settings/fiscal_year
PUT /settings/fiscalyear
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/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
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/unsubscribe_links
GET /settings/unsubscribelinks
PUT
/settings/unsubscribe_links
PUT /settings/unsubscribelinks
POST
/settings/unsubscribe_links
POST /settings/unsubscribelinks
GET
/settings/unsubscribe_links/{id}
GET /settings/unsubscribelinks/111111000000115718
PUT
/settings/unsubscribe_links/{id}
PUT /settings/unsubscribelinks/111111000000115722
DELETE
/settings/unsubscribe_links/{id}
DELETE /settings/unsubscribelinks/111111000000115722
GET
/settings/unsubscribe_link/actions/associations
GET /settings/unsubscribelink/actions/associations
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}
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/automation/cadences
GET - Get all cadences
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/data_sharing
Get Data Sharing
PUT
/settings/data_sharing
Update Data Sharing
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/appointment_preferences
Retrieve Appointment Preferences
PUT
/settings/appointment_preferences
Update Appointment Preferences
GET
/settings/fields/{fieldId}/pick_list_values
Retrieve pick list values for a field
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/zia/data_enrichment
get Zia Enrichment Configuration for a specific module
GET
/settings/emails/actions/from_addresses
Get From Addresses
GET
/settings/tags/{id}/actions/records_count
GET /settings/tags/{id}/actions/recordscount
POST
/settings/tags/{id}/actions/merge
POST /settings/tags/{id}/actions/merge
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
Schemas 755
The contract defines 755 schemas that model the data the API accepts and returns. The most detailed are FieldSchema_2 (88 properties), FieldSchema (72 properties), User (46 properties), CustomViewGetItem (25 properties). Each schema is shown below with its type and property counts.
GetDuplicateCheckPreference
object
Schema for getting duplicate check preference
1 property
1 required
PickListReferenceValue
string
Reference value of the picklist field.
PickListActualValue
string
Actual value of the picklist field.
PickListDisplayValue
string
The picklist display value(translated value if translation enabled).
ApiName
string
API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores.
ModulepluralLabel
string
Plural label of the module.
Id
string
Id of the resource.
InvalidIdentifierError
object
The provided id or rid is invalid. Returns code INVALIDDATA with a descriptive message, status, and validation details.
4 properties
4 required
VariableGroupUpdateItemAlt
object
Alternate schema instance for updating a variable group with id (required), rid, name, apiname, and description.
5 properties
1 required
MandatoryFieldIdMissingError
object
The required field id is missing from the request. Provides code MANDATORYNOTFOUND, message, status, and validation details.
4 properties
4 required
PermissionDeniedError
object
The client does not have permission to access variable group settings. Provides the error code NOPERMISSION, message, status, and details.
4 properties
4 required
VariableGroupOperationStatus
object
Per-item result for a variable group operation, including code, message, status, and contextual details.
4 properties
MandatoryFieldMissingError
object
A required field is missing in the request. Includes code MANDATORYNOTFOUND, message, status, and validation details.
4 properties
4 required
VariableGroupSummary
object
Key attributes of a variable group as returned by the settings resource, including display label, API name, name, description, id, source, and rid.
7 properties
5 required
ApiNamePatternMismatchError
object
The apiname value does not comply with the required pattern. Returns code PATTERNNOTMATCHED with details.
4 properties
4 required
ErrorResponseCore1117753881
object
duplicate data
4 properties
4 required
VariableGroupSummaryLookup
object
Variable group attributes returned when retrieving records by a specific identifier, including display label, API name, name, description, id, source, and rid.
7 properties
6 required
InvalidVariableGroupsTypeError
object
The variablegroups field has an invalid data type. Returns code INVALIDDATA with message, status, and detailed validation info.
4 properties
4 required
InvalidDataError
object
The request contains invalid data. Provides code INVALIDDATA, message, status, and validation details.
4 properties
4 required
VariableGroupDefinitionRequestAlt
object
Alternate request wrapper containing the variablegroups array for defining or updating variable group metadata.
1 property
1 required
VariableGroupUpdateRequestAlt
object
Alternate request wrapper containing a variablegroups array of update items for batch processing.
1 property
1 required
VariableGroupFieldPathDetails
object
Details identifying the field (apiname) and its jsonpath within the payload for context in per-item results.
3 properties
SystemVariableGroupActionNotAllowedError
object
The operation is not supported for system-defined variable groups. Returns code CANNOTPERFORMACTION with details.
4 properties
4 required
VariableGroupListResponse
object
Wrapper object containing the variablegroups array of variable group summaries returned by the settings listing operation.
1 property
1 required
VariableGroupMultiStatusResponseAlt
object
Alternate multi-status response schema exposing a variablegroups array with per-item operation results.
1 property
InvalidFieldDataTypeError
object
One or more fields contain values with an invalid data type. Returns code INVALIDDATA with detailed validation information.
4 properties
4 required
VariableGroupCollectionResponse
object
Successful response containing the current collection of variable groups after processing the request.
1 property
VariableGroupQueryResponse
object
Container for results of a targeted variable group retrieval, exposing a variablegroups array of lookup summaries.
1 property
1 required
ProcessingAmbiguityError
object
Ambiguity occurred while processing the request. Returns code AMBIGUITYDURINGPROCESSING with supporting details.
4 properties
4 required
InvalidVariableGroupIdError
object
The provided variable group id is invalid. Includes code INVALIDDATA with message, status, and details.
4 properties
4 required
VariableGroupOperationResponse
object
Successful response containing variablegroups with per-item operation statuses for the requested action.
1 property
DuplicateVariableGroupError
object
Duplicate data detected for one or more variable groups. Includes code DUPLICATEDATA with supporting details.
4 properties
4 required
VariableGroupDefinitionInputAlt
object
Alternate schema instance for variable group definition with name, description, and apiname.
3 properties
ErrorResponse
object
Standard error response payload.
4 properties
4 required
ErrorItemInvalidRequest
object
Error item for invalid request payloads
4 properties
4 required
FolderRef
object
Reference to a folder
2 properties
2 required
MergeModule
object
A module with available merge fields for email templates
6 properties
6 required
ErrorSingleOne
Single error item - can be one of multiple error types
ErrorItemBase
object
Base structure for error items
4 properties
4 required
ModuleRef
object
Reference to a module
2 properties
2 required
ErrorItemInvalidDataForGet
Error for invalid data or module
MergeFieldsMetadata
object
Metadata about available merge fields and variables for email templates
2 properties
2 required
ErrorItemPatternNotMatchedForGet
Error for pattern validation failure
MergeField
object
A field available for merge in email templates
4 properties
4 required
InfoBlock
object
Pagination information for the response
4 properties
4 required
ErrorItemMandatoryNotFoundForGet
Error for missing mandatory fields
UserRef
object
Reference to a user
2 properties
2 required
EmailTemplatesSuccessResponse
object
Successful response for email templates retrieval
3 properties
2 required
MultiEmailTemplateItem
object
Email template item in list view with summary information
18 properties
18 required
WebhookRequestBody
object
Defines the structure of the request body for a webhook, including data format and content to be sent during POST and PUT operations.
4 properties
1 required
InvalidUrlErrorResponse
object
Error response indicating an invalid URL was entered, advising correction to a valid and well-formed URL.
4 properties
4 required
ErrorResponseCore10
object
If authentication is 'general' and connection name is given .
4 properties
4 required
GeneratedSchema8
object
Nested schema for workflowrule
2 properties
ErrorResponseCore5
object
Locked webhooks can not be edited
4 properties
4 required
GeneratedSchema11
object
Nested schema for webhook
2 properties
GeneratedSchema15
object
Success delete
1 property
CreateWebhooksSuccessResponse
object
Successful response for a webhook creation request, confirming the status and relevant details of each created webhook.
1 property
GeneratedSchema16
object
Nested schema for formdatacontent
3 properties
InvalidDateRangeErrorResponse
object
Error when the provided date range is invalid, advising rectification of 'from' and 'to' dates in the request.
4 properties
4 required
GeneratedSchema19
object
Nested schema for urlparameters
GeneratedSchema2
object
When one webhook got deleted successfully while other tasks failed
1 property
NoPermissionErrorResponse
object
Error response indicating a user's lack of permissions to perform a specific action on the workflow.
4 properties
4 required
ErrorResponseCore11
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
ErrorResponseCore3
object
Invalid ID
4 properties
4 required
InvalidDataErrorResponse
object
Error response indicating invalid data was supplied in a request, with details about the error code and message.
4 properties
4 required
UnsupportedMergeFieldErrorResponse
object
Error response when unsupported fields are present, highlighting the usage of unsupported merge fields.
4 properties
4 required
AutomationCreatedByResponse
object
Information about the creator of a specific automation assignment rule, including the creator's name and ID.
2 properties
ErrorResponseCore12
object
command center, Marketplace
4 properties
4 required
InvalidModuleErrorResponse
object
Error response when a module provided in a request is invalid, including error code, status, and descriptive message.
4 properties
4 required
GeneratedSchema7
object
Request body schema
1 property
1 required
ErrorResponseCore4
object
Given module is invalid
4 properties
4 required
GeneratedSchema12
object
Nested schema for entitydetails
3 properties
AutomationWebhooksResponse
object
Comprehensive details of a webhook related to automation, including creation/modification details, editable status, associated modules, and more.
22 properties
5 required
GeneratedSchema5
object
Nested schema for datetimeformat
3 properties
NameLimitExceededErrorResponse
object
Error response for exceeding the character limit in a name field, indicating the need to shorten the name supplied.
4 properties
4 required
ErrorResponseCore1
object
Webhook Associated with Rules
4 properties
4 required
ErrorResponseCore9
object
Only maximum of 10 actions can be deleted
4 properties
4 required
InvalidMethodTypeErrorResponse
object
Error response when an invalid HTTP method is specified, indicating the unavailability of this method for the requested operation.
4 properties
4 required
PaginationInfoResponse
object
Contains pagination metadata such as number of items per page, total count, current page number, and whether more records are available.
5 properties
InvalidDateTimeFormatErrorResponse
object
Signifies an issue with date-time formatting, advising the correction to a valid and standard format.
4 properties
4 required
ErrorResponseCore16
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
ErrorResponseCore13
object
If http method is not given
4 properties
4 required
WebhookAuthenticationDetails
object
Specifies the authentication method and related details for securing a webhook endpoint, ensuring authorized access.
2 properties
1 required
GeneratedSchema1
object
Success message
2 properties
InvalidTimezoneErrorResponse
object
Indicates an error due to an invalid timezone specification, requiring adjustment to a supported timezone value.
4 properties
4 required
GeneratedSchema10
object
Nested schema for resource
2 properties
DuplicateDataErrorResponse
object
Indicates duplicates in module or custom parameter names, instructing to ensure unique names are used.
4 properties
4 required
CreateWebhooksRequestBody
object
Request body structure for creating new webhooks, including an array of webhook objects with all necessary details.
1 property
1 required
GeneratedSchema20
object
Success Case
1 property
AutomationLockStatusResponse
object
Represents the lock status property of an automation assignment rule, indicating whether the rule is currently locked.
2 properties
ErrorResponseCore7
object
The required parameter is missing
4 properties
4 required
ErrorResponseCore2
object
Mandatory param is not given
4 properties
4 required
ErrorResponseCore14
object
Missing required parameter: groupby
4 properties
4 required
InvalidNameErrorResponse
object
Error response indicating the use of invalid characters in a name field, providing feedback on unsupported characters.
4 properties
4 required
ErrorResponseCore6
object
Missing required parameter: ids
4 properties
4 required
ErrorResponseCore18
object
If given parameters are not allowed for given http method
4 properties
4 required
GeneratedSchema4
object
Success response
1 property
WebhookHeaders
object
Encapsulates headers for webhook requests including both module-specific and custom parameters, required for sending extra information.
2 properties
1 required
WebhookStatusResponse
object
Represents the status information of a webhook including operational code, message, and status details.
4 properties
AmbiguityProcessingErrorResponse
object
Error response indicating a processing ambiguity when module ID and API name do not refer to the same module.
4 properties
4 required
AutomationModifiedByResponse
object
Details about the person who last modified a specific automation assignment rule, including their name and ID.
2 properties
GeneratedSchema6
object
Nested schema for associatedmodules
2 properties
GeneratedSchema18
object
SUCCESS RESPONSE
1 property
GeneratedSchema14
object
Nested schema for userdefinedparameter
2 properties
GeneratedSchema9
objectnull
Nested schema for relatedmodule
2 properties
ErrorResponseCore8
object
Auto-generated from ApiDefinition for MANDATORYNOTFOUND
4 properties
4 required
GeneratedSchema3
object
Nested schema for webhookfailures
6 properties
ErrorResponseCore17
object
if value || name is not given in custom parameters
4 properties
4 required
InvalidActionIDErrorResponse
object
Error due to an invalid action ID provided within a request, requiring validation and resubmission of the correct ID.
4 properties
4 required
ErrorResponseCore15
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
GeneratedSchema13
object
Success response
2 properties
ErrorResponseCore
object
If given connection name is invalid
4 properties
4 required
WebhookCustomParameters
object
Contains static header names and values that are always included in webhook requests for customization.
2 properties
GetWebhooksSuccessResponse
object
Successful response structure for fetching a list of webhooks, including webhook data and pagination information.
2 properties
GeneratedSchema17
object
Nested schema for datausage
4 properties
InvalidDateFormatErrorResponse
object
Error response for issues with date format, directing the user to supply a properly formatted date string.
4 properties
4 required
GeneratedSchema
object
Success message
1 property
WebhookDetailsResponse
object
Nested details about a webhook, providing a unique identifier to distinguish it within the system.
1 property
AutomationModuleDetailsResponse
object
Provides details of a module within an automation assignment rule, including API name and module ID.
2 properties
WebhookModuleParameters
object
Defines headers with unique names and values for sending additional information via webhook requests, such as API keys or tokens.
2 properties
RelatedListParentReference
object
Parent related list reference required for contextual dependencies.
2 properties
2 required
ValidationError
object
Validation error response structure
4 properties
4 required
RelatedListRecordOperations
object
Flags indicating the record operations allowed on the related list.
6 properties
6 required
RelatedListModule
object
Metadata describing the module associated with the related list.
3 properties
2 required
RelatedList
object
Configuration metadata for a related list.
21 properties
12 required
ErrorDetail
object
Detailed information about a validation error
9 properties
InvalidModuleError
object
Invalid Validation error response structure
4 properties
4 required
BusinessHoursErrorResponses
ErrorResponse_2
object
Business hours error details
4 properties
4 required
ReorderWorkflowRulesRequestSchema
object
Alternate request body wrapper containing the reorder payload for adjusting workflow rule execution order.
1 property
1 required
WorkflowConditionActionCountSummarySchema
object
Aggregates action counts for a workflow rule condition, including its sequence number, instant action counts, scheduled action counts, and condition ID.
4 properties
4 required
StringValueNested
string
The actual value to insert into the field
QueuedActionUsageMetricsSchema
object
Usage metrics for an action, including queue count, success and failure counts, related email engagement metrics (if applicable), and action identifiers.
8 properties
8 required
ConditionsNestedSchema
object
An array of condition objects that define the criteria for executing the actions.
5 properties
3 required
NonAssociateActionsNestedSchema
object
An array of action objects
5 properties
1 required
DetailsNestedForEmailSchema
object
Contains details about the trigger.
4 properties
InstantActionsUsageWithTagsSchema
object
Container for instant actions that carry tag information, listing each tagged action's usage metrics.
1 property
1 required
ModuleOrFieldNestedSchema
object
Specify the module/field to which the workflow rule applies
2 properties
ExecuteWhenRecommendation
object
Schema for executewhen object
2 properties
2 required
ExecutionTimeObjectValueNested
object
The actual value to insert into the field
5 properties
4 required
CriteriaDetailsNestedSchema
object
Specify the conditions a record must meet for the workflow rule to trigger. Set this to null to apply the rule to all records in the module.
2 properties
OwnerObjectValueNested
object
The actual value to insert into the field
2 properties
1 required
DetailsNestedForAppointmentSchema
object
Contains details about the trigger.
3 properties
ExpectedFieldMissingSchema
object
Module API name and ID are not provided
4 properties
4 required
ScheduledActionsForWorkflowUsageSchema
array
List of scheduled actions associated with the workflow rule.
PostWorkflowRuleSchema
object
Request body schema
1 property
1 required
FieldMappingsNestedSchema
object
Specify the list of fields and values to be set in the new record
4 properties
3 required
ExecuteWhenDateTime
object
Schema for executewhen object
2 properties
2 required
ModuleSpecificCountsResponseAllSchema
object
Alternate successful response model for module-specific workflow rule counts.
1 property
1 required
SingleCriteriaSchema
object
A leaf condition comparing a field to a value.
4 properties
3 required
LayoutNestedSchema
object
Specify the details of the layout in which the record should be created
3 properties
1 required
ActionsCountSummarySchema
object
Collection of count entries for instant (immediate) actions in a workflow rule condition. Contains an array of action-type and count pairs.
1 property
1 required
HostUnavailableNestedSchema
Specify fallback option in case the host is not available
InstantActionsUsageListSchema
object
Container for a list of instant actions executed within a condition, each with usage metrics.
1 property
1 required
LockedByObjectSchema
object
Field: lockedby
2 properties
ExecuteWhenSectionUpdate
object
Schema for executewhen object
2 properties
2 required
WorkflowRulesGetResponseSchema
object
Single Workflow Rule Response Body.
2 properties
2 required
DetailsNestedForSectionUpdateSchema
object
Contains details about the trigger.
3 properties
NoPermissionSchema
object
No permission to access the feature/module
4 properties
4 required
ActivationStatusSchema
object
Indicates whether the workflow is currently active, represented by a boolean value.
1 property
WorkflowRulePostNestedSchema
object
Root Element of the workflow rule
6 properties
4 required
AlreadyUsedSchema
object
The resource you are trying to create already exists
4 properties
4 required
ExecuteWhenEmail
object
Schema for executewhen object
2 properties
2 required
ExecuteWhenCreateOrDelete
object
Schema for executewhen object
2 properties
2 required
WorkflowSuccessSchema
object
Workflow Rule created successfully
1 property
DetailsNestedForRollupSummarySchema
object
Contains details about the trigger.
2 properties
ConvertDetailsSchema
object
Specify the details of the action
8 properties
DependentMisMatchSchema
object
moduleselection should be specific
4 properties
4 required
UpdateWorkflowRuleSchema
object
Request body schema
1 property
1 required
ArrayValueNested
array
The actual value to insert into the field
WorkflowActionCountsResponseSchema
object
Successful response containing a list of workflow rules with their condition-level instant and scheduled action counts.
1 property
1 required
DetailsNestedSchema
object
Contains details about the trigger.
1 property
1 required
WorkflowRulePutNestedSchema
object
The request body must contain a workflowrules array. You can include only one object in this array per request.
8 properties
ModuleSpecificActionsCountSchema
object
Counts of workflow rules for a specific module, including active and total configured rules, alongside the module reference.
3 properties
3 required
WorkflowConditionUsageSummarySchema
object
Summarizes usage for a workflow condition, combining instant action usage, scheduled action usage groups, total usage count, and condition ID.
4 properties
4 required
WorkflowConditionUsageWithTaggedInstantActionsSchema
object
Condition-level usage summary where instant actions include tag details; also includes scheduled actions (if any), usage count, and condition ID.
4 properties
4 required
TimeObjectSchema
stringnull
Time Object
SuccessResponseDetailsSchema
object
Nested schema for details
1 property
MeetingDurationNestedSchema
object
Denotes the duration of the meeting. Specify the time period and unit
2 properties
2 required
LockStatusSchema
object
Details the lock status of the workflow, including information about who locked it, the message associated with the lock, and whether it is currently locked.
3 properties
ExecuteWhenAppointment
object
Schema for executewhen object
2 properties
2 required
UrlIdMissingSchema
object
the id given seems to be invalid
4 properties
4 required
AssociateActionsNestedSchema
object
An array of action objects
5 properties
1 required
EmailEngagementMetricsSchema
object
Metrics related to email-based actions, including sent, delivered, opened, clicked, bounced, unsent, unopened counts, and sent percentage. Used in workflow act…
9 properties
9 required
ObjectValueNested
The actual value to insert into the field, can be an Owner object or ExecutionTime object.
ReOrderSuccessResponseSchema
object
Workflow Rule created successfully
1 property
DependentFieldMissingSchema
object
Action details are missing
4 properties
4 required
GroupCriteriaSchema
object
A group of conditions combined using a logical operator.
2 properties
2 required
DetailsCriteriaNestedSchema
object
Define the condition to evaluate on the rollup summary field. The object must include field, comparator and value.
3 properties
DetailsNestedForRecommendationSchema
object
Contains details about the trigger.
3 properties
WorkflowRuleActionCountGroupSchema
object
Encapsulates a workflow rule and its associated list of conditions with action counts. Includes the workflow rule ID and conditions array.
2 properties
2 required
ScheduledActionsUsageGroupSchema
object
Represents a scheduled action group with its ID and an array of action usage entries.
2 properties
2 required
ExecuteWhenCreateEditOrEdit
object
Schema for executewhen object
2 properties
2 required
AssignOwnerDetailsSchema
object
Contains details about the trigger.
8 properties
2 required
WorkflowRuleUsageResponseSchema
object
Successful response containing usage details for the specified workflow rule, including condition-level instant and scheduled action metrics.
1 property
1 required
ExecuteWhenRollupSummary
object
Schema for executewhen object
2 properties
2 required
InfoNestedSchema
object
Nested schema for info
4 properties
4 required
WorkflowRulesCountResponseSchema
object
Successful response containing the workflow rules quota summary for the organization.
1 property
1 required
SuccessResponseNestedSchema
object
Nested schema for workflowrules
4 properties
DetailsNestedWithRepeatMatchAllSchema
object
Contains details about the trigger.
4 properties
ExecuteWhenRepeatMatchAll
object
Schema for executewhen object
2 properties
2 required
CreatedModifiedByObjectSchema
object
Field: createdby
2 properties
AmbiguityDuringProcessingSchema
object
Auto-generated from ApiDefinition for AMBIGUITYDURINGPROCESSING
4 properties
4 required
ExecuteWhenSelectiveScoring
object
Schema for executewhen object
2 properties
2 required
DetailsNestedForSelectiveScoringSchema
object
Contains details about the trigger.
3 properties
ScheduledActionsNestedSchema
arraynull
The list of Scheduled Actions to execute when condition is met
AssignToNestedSchema
Specifies how the new owner should be assigned
TagActionSchema
object
Specify the details of the action
3 properties
1 required
InvalidDataNoApiNameAndPathSchema
object
Required Param missing
4 properties
4 required
ActionUsageMetricsSchema
object
Usage details for an action without queue metrics, including success and failure counts, action identifiers, type, and associated time.
6 properties
6 required
TaggedActionUsageMetricsSchema
object
Usage metrics for an action that includes an associated tag ID, along with success/failure counts, identifiers, type, and time.
7 properties
7 required
DetailsNestedWithRepeatSchema
object
Contains details about the trigger.
2 properties
DetailsNestedForDatetimeSchema
object
Contains details about the trigger.
7 properties
MeetingOrCallActionSchema
object
Specify the details of the action
6 properties
3 required
InstantActionsNestedSchema
object
The list of Instant Actions to execute immediately when condition is met. Maximum 5 instant action
1 property
1 required
RelatedDetailsNestedSchema
ResourceNestedSchema
object
Specify the details based on the owner assignment
3 properties
1 required
WorkflowRuleSingleGetResponseSchema
object
Single Workflow Rule Response Body.
1 property
1 required
WorkflowRuleSingleGetSchema
object
Comprehensive workflow rule entity for automation settings, including metadata, execution timing, module, ownership, lock status, conditions, and activation st…
18 properties
15 required
LimitExceededSchema
object
Auto-generated from ApiDefinition for LIMITEXCEEDED
4 properties
4 required
ExecuteWhenNestedSchema
InvalidModuleErrorResponse_2
object
Error response indicating an invalid module parameter, specifying the error code and message.
4 properties
4 required
ModifierDetails
object
Provides details about the individual who modified an entity, including their name and ID.
2 properties
GeneratedSchema1_2
object
When one task got deleted successfully while other tasks failed.
1 property
FieldAttributes
object
Describes a field in a module, including its API name and identifier.
2 properties
2 required
LockStatus
object
Represents the lock status of a resource, indicating whether it is currently locked or not.
1 property
ErrorResponseCore10_2
object
Task Associated with Rules
4 properties
4 required
GeneratedSchema8_2
object
Success Case
1 property
ErrorResponseCore5_2
object
Invalid Data
4 properties
4 required
GeneratedSchema6_2
object
Success response
1 property
GeneratedSchema7_2
object
Success response
1 property
ModuleDetails
object
Contains information about a module, including labels and API names.
5 properties
1 required
RelatedModuleDetails
objectnull
Describes a related module, with details about its labels, API name, and ID.
5 properties
FieldMappings
object
Defines mappings of fields, including display values, types, and associated fields.
4 properties
2 required
ErrorResponseCore4_2
object
When 'field' is missing
4 properties
4 required
GeneratedSchema9_2
object
Nested schema for tasks
4 properties
GeneratedSchema5_2
object
Success Case
1 property
ErrorResponseCore1_2
object
Ambiguity in field/module
4 properties
4 required
GeneratedSchema2_2
object
Request body schema
1 property
1 required
ErrorResponseCore9_2
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
CreatorDetails
object
Provides details about the creator of an entity, including their name and ID.
2 properties
GetTasksSuccessResponse
object
The successful response structure for retrieving tasks, including lists of tasks and pagination info.
2 properties
PaginationInfo
object
Details about pagination for resource listings, such as count, page number, and if more records are available.
4 properties
ErrorResponseCore8_2
object
Invalid Module
4 properties
4 required
ErrorResponseCore2_2
object
When the dependent field is mismatched (field,value,type)
4 properties
4 required
ErrorResponseCore11_2
object
No permssion CrmImpliedmanageworkflow
4 properties
4 required
ErrorResponseCore7_2
object
In Due date if any of the field is missing (fieldname,sign,days,type)
4 properties
4 required
GeneratedSchema3_2
object
he Task is Deleted successfully
1 property
ErrorResponseCore17_2
object
Subject character limit exceeded
4 properties
4 required
ErrorResponseCore16_2
object
unsupported mergefield provided
4 properties
4 required
ErrorResponseCore14_2
object
Auto-generated from ApiDefinition for MANDATORYNOTFOUND
4 properties
4 required
ErrorResponseCore6_2
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
ErrorResponseCore18_2
object
Locked task cannot be edited
4 properties
4 required
ErrorResponseCore15_2
object
while delete more the 10 id passed throw this error
4 properties
4 required
TaskDetails
object
Describes tasks within the system, including metadata, status, fields, and associated entities.
16 properties
3 required
ErrorResponseCore3_2
object
Invalid Task Id
4 properties
4 required
ErrorResponseCore13_2
object
Invalid Due Date
4 properties
4 required
ErrorResponseCore_2
object
Missing required parameter: ids
4 properties
4 required
GeneratedSchema4_2
object
Nested schema for details
2 properties
GeneratedSchema_2
object
Request body schema
1 property
1 required
ErrorResponseCore19
object
Mandatory Fields is not given
4 properties
4 required
ErrorResponseCore12_2
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
ResultList
object
List of results from the operation.
1 property
1 required
ResultItem
object
Individual result item with status and details.
4 properties
4 required
GeneratedSchema1_3
object
Successful deactivation of a rule
1 property
SuccessResponseDetails
object
Details of an operation, including the identifier of affected fields.
2 properties
ListGETResponse
object
list of configured scoring rules
2 properties
UnsavedCustomFieldDetails
object
Contains detailed information about custom fields that could not be saved during an operation.
1 property
GlobalScoringRuleLimitExceededErrorResponse
object
Error message indicating that the maximum number of scoring rules for a layout has been exceeded, which is capped at 10.
4 properties
4 required
GeneratedSchema8_3
object
few ids are invalid and others rules are deleted.
1 property
ScoringRulePOSTCommon
object
Root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations.
6 properties
2 required
GeneratedSchema6_3
object
Request body schema
ScoringRuleResponseDetails
object
Response details for scoring rule operations, including status, code, and associated messages.
4 properties
GeneratedSchema10_2
object
Nested schema for createdby
3 properties
GeneratedSchema7_3
object
All rules are deleted successfully
1 property
GeneratedSchema15_2
object
successful cloning of a rule
1 property
FieldScoreConfiguration
object
Defines the score configuration for module fields based on specific criteria.
3 properties
ModuleDetails_2
object
Provides details of a module, including API name and module ID.
2 properties
LayoutDetails
objectnull
Information about layout configuration, including display label, API name, and ID.
3 properties
GeneratedSchema14_2
objectnull
Nested schema for modifiedby
3 properties
GeneratedSchema16_2
object
Scoring rule successfully activated
1 property
ZiaScoringRuleWrapper
PartialSuccessResponse
object
Response indicating partial success when some scoring rules are created successfully, and others fail.
1 property
ErrorResponseCore4_3
object
given scoring rule id is invalid
4 properties
4 required
ScoringRulePUT
object
Root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations.
7 properties
ActiveStateLimitErrorResponse
object
Error indicating that the maximum number of active scoring rules per layout has been exceeded.
4 properties
4 required
GeneratedSchema12_2
object
Rule successfully updated
1 property
GeneratedSchema5_3
object
Few rule object has errors, others are updated successfully.
1 property
ZiaScoringRule
objectnull
Defines the scoring rule configuration used by Zia for predictive scoring. Includes main scoring criteria, training data, favourable and unfavourable condition…
3 properties
ScoringRuleGET
object
Root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations.
14 properties
2 required
ManualScoringRuleWrapper
GeneralErrorResponse
object
For the error response other than the mentioned ones
4 properties
ScoringRulePOST
Schema for creating a scoring rule, supporting both manual and Zia scoring types.
ReferencedScoreField
object
Contains the API name of the referenced score field used in scoring rules.
2 properties
SuccessResponseGET
object
Scoring rule details
1 property
CustomFieldConfiguration
object
Configuration for custom fields associated with scoring rules, including referred scores.
4 properties
GeneratedSchema3_3
object
Nested schema for info
4 properties
GeneratedSchema13_2
object
Request body schema
TouchPointScoreConfiguration
object
Configuration for applying scores based on touch points for Leads and Contacts modules.
2 properties
ErrorResponseCore3_3
object
invalid module apiname is passed in module param value
4 properties
4 required
ScoringRuleListGET
object
Root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations.
14 properties
2 required
ManualScoringRule
objectnull
includes fieldrules and touchpointrules of manual scoring rules
3 properties
GeneratedSchema4_3
object
successful deletion of a rule
1 property
CreateScoringRuleSuccessResponse
object
Successful creation response for scoring rules, containing details of the created rules.
1 property
ScoringType
string
Type of the scoring rule
GeneratedSchema_3
object
Rules updated successfully
1 property
CrossFilters
array
List of cross-module filters that further refine favourable scoring conditions.
CreateScoringRuleRequestBody
object
Schema for creating scoring rules, containing an array of scoring rule definitions.
1 property
1 required
RequestBodyPUT
object
Request body schema
1 property
1 required
LayoutActivateRequest
object
Request payload for activating a single layout with optional profile associations. Only one layout can be activated per request.
1 property
1 required
GetSpecificAssignmentRuleSuccessResponse
object
Get all assignment rules success response
1 property
ErrorResponseInvalidModule
object
Error response when module given is invalid
4 properties
4 required
RoleGroupProfileTypeAssignToResponseObject
object
Defines the criteria and list of users eligible for record assignment upon entering the current rule entry.
2 properties
2 required
RuleEntryResponseObject
object
Defines entries with matching and assignment logic for record processing.
6 properties
6 required
AssignmentRuleResponseObject
object
Details of the assignment rule
10 properties
9 required
DefaultAssigneeResponseObject
object
Details of the fallback user for record assignment in cases where the owner cannot be assigned through rule entries.
4 properties
ErrorResponseNoPermissionToManageAR
object
If current user does not have permission to manage assignment rules of given module
4 properties
4 required
Possible403ErrorResponsesInManagingAR
object
Error response for forbidden access
ErrorResponseNoPermissionToAccessAPI
object
If current user does not have permission to access api
4 properties
4 required
CriteriaTypeAssignToResponseObject
object
Defines the criteria and list of users eligible for record assignment upon entering the current rule entry.
2 properties
2 required
AssignmentRuleResponseObjectWithRuleEntries
object
Details of the assignment rule
11 properties
10 required
ErrorResponseModuleNotSupported
object
Error response for a module that is valid but unsupported in assignment rule processes.
4 properties
4 required
ResourceResponseObject
object
Resource details
4 properties
2 required
UsersTypeAssignToResponseObject
object
Defines the criteria and list of users eligible for record assignment upon entering the current rule entry.
2 properties
2 required
ZiaSuggestedUsersTypeAssignToObject
object
If assign to type is zia suggested user
1 property
1 required
DetailsSchema
nullobject
Details Schema
GetAllAssignmentRulesSuccessResponse
object
Get all assignment rules success response
1 property
FollowupActionsResponseObject
object
List of actions to be executed following the assignment of ownership to a record.
2 properties
1 required
IdSchema
string
ID of the resource
ErrorResponseNoPermissionToManageAROfPrivateModule
object
If current user is neither the org admin nor the admin of the given private module
4 properties
4 required
ErrorResponseFeatureNotSupported
object
Feature not supported
4 properties
4 required
AssignToResponseObject
Assign to response object schema
TransferToIdNotFoundError
object
Error when transfertoid is mandatory but missing.
4 properties
4 required
InternalServerError
object
Internal server error response.
4 properties
4 required
TypeNull
null
Represents a null value
ApiName_2
string
API name of the profile. API identifier using alphanumeric characters and underscores, must start with a letter
UserReference
object
Reference to a user who performed an action
2 properties
2 required
CloneProfileActionResponse
object
Action response for clone profile operation.
4 properties
4 required
MandatoryNotFoundProfileError
object
Per-profile validation error for missing mandatory fields.
4 properties
4 required
CloneProfileInvalidProfileNameSpecialCharsErrorResponse
object
Error response when the cloned profile name contains disallowed special characters.
1 property
1 required
DeleteProfileInvalidIdErrorResponse
Error response when the profile id in the delete profile request path is invalid or already deleted.
UpdateProfileInvalidProfileNameSpecialCharsErrorResponse
object
Error response when the profile name contains disallowed special characters during update.
1 property
1 required
CloneProfileInvalidIdErrorResponse
Error when the profile ID in the clone profile request path is invalid or already deleted.
UpdateProfileChildPermissionParentDisabledErrorResponse
object
Error response when attempting to enable a child permission while its parent permission is disabled.
1 property
1 required
LicenseLimitExceededError
object
Per-profile license limit exceeded error.
4 properties
4 required
CloneProfileInvalidCreateRequestErrorResponse
object
Error response when clone profile request payload validation fails (missing mandatory fields).
1 property
1 required
PermissionErrorResponse
object
Error response when user lacks permission to perform the operation.
4 properties
4 required
CloneProfileDuplicateProfileNameErrorResponse
object
Error response when the requested cloned profile name conflicts with an existing profile name.
1 property
1 required
UpdateProfilePermissionNotAllowedErrorResponse
object
Error response when a permission id in permissions[] cannot be updated.
1 property
1 required
UpdateProfileDuplicateDataErrorResponse
object
Error response when updating a profile fails due to duplicate profile name.
1 property
1 required
InvalidIdError
object
Error when the profile ID is invalid or deleted.
4 properties
4 required
DuplicateProfileNameError
object
Per-profile duplicate data error.
4 properties
4 required
ModifiedTime
DeleteProfileSystemProfileNotAllowedErrorResponse
object
Error response when attempting to delete a system profile (not allowed).
4 properties
4 required
CloneProfileResponse
object
Response returned after cloning a profile.
1 property
1 required
ProfileSectionCategoryModule
object
Module reference used inside profile sections/categories.
2 properties
2 required
InvalidRequestMethodError
object
Error when HTTP method is not supported.
4 properties
4 required
InvalidDeleteRequestError
object
Error when profile deletion is not allowed.
4 properties
4 required
UnauthorizedError
object
Unauthorized error response.
4 properties
4 required
UpdateProfileInvalidPermissionIdErrorResponse
object
Error response when an invalid permission id is provided in profiles[].permissionsdetails during update.
1 property
1 required
ProfilePermissionModule
object
Module reference used within a profile permission detail.
2 properties
2 required
Filters
object
Filter definition for querying profiles.
2 properties
2 required
UpdateProfileSystemProfileNotAllowedErrorResponse
object
Error response when attempting to update a system profile (not allowed).
4 properties
4 required
CreatedTime
CreatedBy
Id_2
string
Unique identifier (64-bit integer represented as string)
ProfileName
string
profile name
InvalidTransferToIdError
object
Error when provided transfertoid is invalid or deleted.
4 properties
4 required
DeleteProfileInvalidActionErrorResponse
object
Error response when the action given for delete profile is invalid.
4 properties
4 required
Timestamp
string
ISO 8601 datetime with timezone offset when the profile action was performed. (e.g., 2024-05-17T09:15:56+05:30)
FilterCondition
object
Single filter condition.
4 properties
4 required
ModifiedBy
CloneProfileCannotBeClonedErrorResponse
object
Error response when the specified profile cannot be cloned.
1 property
1 required
InvalidUrlPatternErrorResponse
object
Error response for invalid URL patterns.
4 properties
4 required
UpdateProfileInvalidActionErrorResponse
object
Error response when the action given in the update profile request is invalid.
1 property
1 required
UpdateProfileInvalidPermissionsDetailsDatatypeErrorResponse
object
Error response when permissionsdetails is of an unexpected datatype in update profile request.
4 properties
4 required
InvalidQueryParamError
object
Error when a request query parameter has an invalid value.
4 properties
4 required
CloneProfileLicenseLimitExceededErrorResponse
object
Error response when cloning a profile exceeds the allowed license/profile limit.
1 property
1 required
DeletefieldupdatesResponse200
object
Deletes one or more field updates specified in the ids parameter
1 property
ErrorResponseCore2006990805
object
Missing required parameter: includeinnerdetails
4 properties
4 required
Get3361265000006103409Response200
object
FieldUpdate GET API Success Response
1 property
ErrorResponseCore45599694
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
FieldUpdatesNested
object
Contains the data to create a field update action.
22 properties
5 required
Delete3361265000006103409Response200
object
Indicates that the field update was deleted successfully.
1 property
ErrorResponseCore552800690
object
Invalid data type for field: fieldupdates
4 properties
4 required
ErrorResponseCore1609075774
object
Represents module ID and API name do not match the same module.
4 properties
4 required
ErrorResponseCore685771708
object
Field update deletion is not allowed because it is associated with an automation feature.
4 properties
4 required
ErrorResponseCore115741934
object
Represents one or more dependent fields are missing.
4 properties
4 required
FieldNested
object
Specify the API name and the unique ID of the field to be updated.
3 properties
ErrorResponseCore2113490893
object
Indicates that the user does not have the necessary permissions to create a field update action.
4 properties
4 required
ModifiedByNested
object
Nested schema for modifiedby
2 properties
RelatedRecordsNested
object
Specify the list of related modules (Tasks, Calls and Events) whose ownership should also be updated.
2 properties
CreatedByNested
object
Nested schema for createdby
2 properties
ErrorResponseCore1522103906
object
Indicates that no field update ID was provided for the edit operation.
4 properties
4 required
Put3361265000006103409Response200
object
Represents the success response for a field update modification.
1 property
PostfieldupdatesRequest
object
Request body schema
1 property
1 required
InfoNested
object
Nested schema for info
4 properties
ErrorResponseCore978443965
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
GetfieldupdatesResponse200
object
Represents that all field updates have been retrieved successfully
2 properties
ErrorResponseCore467453316
object
Represents unsupported keys are mentioned in the input.
4 properties
4 required
FieldUpdatesNested1
object
Nested schema for fieldupdates
4 properties
ErrorResponseCore1841130033
object
Auto-generated from ApiDefinition for MANDATORYNOTFOUND
4 properties
4 required
ModuleNested
object
Specify the module details where the field update should be applied.
5 properties
ErrorResponseCore702850683
object
Indicates that no field update ID was provided for the delete operation.
4 properties
4 required
PostfieldupdatesResponse201
object
Represents the success response of Field Update creation.
1 property
ErrorResponseCore984011800
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
DeletefieldupdatesResponse207
object
Indicates that one or more field updates failed to delete while at least one was deleted successfully
1 property
ErrorResponseCore1944579408
object
Represents an invalid field update ID.
4 properties
4 required
DetailsNested
object
Nested schema for details
1 property
Put3361265000006103409Request
object
Request body schema
1 property
1 required
LockStatusNested
object
Nested schema for lockstatus
1 property
DependentFieldsNested
object
Specify the dependent fields that are affected when the target field is updated
2 properties
2 required
ErrorResponseCore44302847
object
Indicates that all field update delete operations failed.
4 properties
4 required
ErrorResponseCore44302846
object
Indicates that all field update delete operations failed.
4 properties
4 required
ErrorResponseCore1296580093
object
Represents field ID and API name do not match the same field.
4 properties
4 required
ShiftHoursSuccessResponse
object
Error scenario
1 property
1 required
ErrorItemInvalidRequest_2
object
Error item for invalid request shape or parse errors.
4 properties
4 required
FolderRef_2
object
Folder reference with id and name.
2 properties
2 required
ErrorItemInvalidData
Error item for invalid data/module
ModuleRef_2
object
Reference to a CRM module (apiname and id).
2 properties
2 required
InventoryTemplateItem
object
Inventory template summary object returned in lists.
12 properties
12 required
UserRef_2
object
User reference with id and display name.
2 properties
2 required
ErrorItemMandatoryNotFound
Error item for missing mandatory field
InventoryTemplatesSuccessResponse
object
Successful response containing inventorytemplates array and pagination info.
2 properties
2 required
InventoryTemplatesErrorResponse
Error response schema for inventory templates operations.
InfoBlock_2
object
Pagination metadata for list responses (perpage, page, count, morerecords).
4 properties
4 required
ErrorItemPatternNotMatched
Error item when a value fails to match a required pattern
InvalidModuleName
object
When Invalid Module Name is passed this error will be thrown
4 properties
4 required
InternalServerError_2
object
Internal server error response object containing code, message, details, and status.
4 properties
4 required
TypeNull_2
null
Null if no information is available.
ModuleName
string
Name of the module
FieldCreationResult
object
Result of a single field creation
4 properties
4 required
ErrorResponse_3
object
Error response structure
FieldRequestBodySchema
object
Request body for creating custom fields. Maximum of 5 fields can be created in a single call.
1 property
CreateFieldsResponse
object
Response from create custom fields API
1 property
1 required
FieldSchema
object
Schema representing a field in the module.
72 properties
45 required
BadRequest
object
Standard error response object.
4 properties
4 required
FieldUpdateRequestBodySchema
object
Request body for updating custom fields. Maximum of 5 fields can be updated in a single call.
1 property
User
object
Schema representing a user in Zoho CRM.
46 properties
15 required
UserInvalidErrorSchemaInURL
object
Details of each user error.
4 properties
4 required
TerritoryUsersLimitExceededErrorSchema
object
A object value.
4 properties
4 required
TerritoryInternalServerErrorSchema
object
A object value.
4 properties
4 required
UserInvalidErrorSchemaOnRequestBody
object
Schema for error responses returned during territory creation or update.
1 property
1 required
TerritoryErrorPermissionDenied
object
A object value.
4 properties
4 required
FieldReference
object
Reference to a field with ID and API name
2 properties
1 required
PicklistOption
object
Picklist option details
3 properties
3 required
SuccessResponse
object
Standard success response structure
4 properties
4 required
PicklistMappingCreate
object
Parent picklist value with its mapped child values for create/update operations
4 properties
2 required
PicklistMappingRead
object
Parent picklist value with complete mapped child values for read operations
4 properties
4 required
PicklistMappingUpdate
object
Parent picklist value with its mapped child values for update operations. Supports deletion with delete property.
4 properties
2 required
SurplusWeekNested
objectnull
In Custom Fiscal Year, a surplus week is an extra week added to keep the fiscal calendar aligned with the actual calendar year.
3 properties
GETSurplusWeekNested
objectnull
Nested schema for surplusweek
3 properties
3 required
FiscalInvalidCalendarTypeError
object
Invalid structure
4 properties
4 required
GETFiscalYearNested
object
Nested schema for fiscalyear
9 properties
9 required
FiscalInvalidDisplayOptionError
object
Invalid displaybasedon
4 properties
4 required
FiscalInvalidStartDateMonthError
object
when startmonth is given and does not match with startdate
4 properties
4 required
DependentFieldMissingError
object
Dependent field missing error
4 properties
4 required
FiscalInvalidStartDateError
object
Invalid startdate
4 properties
4 required
FiscalInvalidSurplusWeekError
object
Invalid surplusweek
4 properties
4 required
FiscalInvalidEndMonthConfigError
object
When displaybasedon configured as 'endmonth' for date lying 'January' or 'February'
4 properties
4 required
GetfiscalyearResponse200
object
Successful API operation completed
1 property
1 required
FiscalYearNested1
object
Nested schema for fiscalyear
4 properties
FiscalInvalidSurpluYearError
object
While configuring surplus week for future years.
4 properties
4 required
FiscalInvalidStartYearError
object
while configuring fiscal year start date other than current year
4 properties
4 required
FiscalInvalidCalendarError
object
Invalid calendartype
4 properties
4 required
AmbiguityError
object
Error due to ambiguity in surplus week configuration
4 properties
4 required
UpdateFiscalYearResponse
object
Successful API operation completed
1 property
FiscalInvalidStructureError
object
Invalid structure
4 properties
4 required
FiscalInvalidMonthError
object
Invalid startmonth
4 properties
4 required
FiscalYearNested
object
Root key of the API
7 properties
FiscalCompletedSurplusError
object
Updating or deleting surplus week for completed years
4 properties
4 required
PutfiscalyearRequest
object
Request body schema
1 property
1 required
ConvertMappingTargetModule
object
Target layout configuration for a module during record conversion.
3 properties
3 required
ApiName_3
string
API identifier using alphanumeric characters and underscores, must start with a letter
UserReference_2
object
Reference to a user who performed an action
2 properties
2 required
LayoutErrorDetails
object
Error details specific to layout operations. Properties vary based on error type.
4 properties
DeleteLayoutResult
object
Result of a single layout deletion operation.
4 properties
4 required
ConvertMappingModule
Convert mapping configuration that defines how records are mapped during conversion. The structure varies based on the module type: - Leads module: Maps to Con…
ProfileReference
object
Profile associated with a layout
6 properties
5 required
DeleteLayoutSuccessResponseBody
object
Response body for successful layout deletion.
1 property
1 required
ModuleName_2
string
Module API name
ConvertMappingTargetModuleWithFields
object
Target layout configuration for a module during record conversion, including required fields that must be populated.
4 properties
4 required
LayoutActionsAllowed
object
Permissions indicating which operations are allowed on a layout
7 properties
7 required
ErrorResponse_4
object
Standard error response structure
4 properties
4 required
LayoutResponseSchema
object
Response containing layout configurations
1 property
1 required
FieldSchema_2
object
Comprehensive schema representing a field in the module layout. This is a reusable schema used across multiple endpoints.
88 properties
LayoutErrorResponse
object
Layout-specific error response structure
1 property
1 required
ActionsAllowed
object
Permissions indicating which operations are allowed on a section
7 properties
7 required
ErrorDetails
object
Additional context-specific error details. Properties vary based on error type.
7 properties
MaskDetailsProfile
object
Profile that has permission to view the unmasked field value.
2 properties
2 required
DeleteLayoutDetails
object
Details of the deleted layout.
1 property
1 required
Id_3
string
Unique identifier (64-bit integer represented as string)
SectionProperties
object
Additional properties for subform sections
5 properties
VariableValueInvalidDataError
object
Indicates invalid data supplied for a variable's value during update. Includes code INVALIDDATA and validation details.
4 properties
4 required
VariableOperationResult
object
Per-item outcome for a variable operation, including code, message, status, and details such as the resulting variable id.
4 properties
VariablesBatchRemovalMultiStatusResponse
object
Batch removal response indicating mixed outcomes for multiple variables, with per-item result details.
1 property
VariablesRemovalFailedError
object
Indicates failure to remove a variable due to an invalid ID or other issues. Includes code INVALIDDATA and validation details.
4 properties
4 required
InvalidUrlPatternError
object
Returned when the requested URL does not match a supported pattern. Includes code INVALIDURLPATTERN.
4 properties
4 required
VariablesPermissionDeniedError
object
Returned when the caller lacks permission to access variables. Includes code NOPERMISSION and validation details.
4 properties
4 required
VariableCreationItem
object
Represents a variable to create, including apiname, name, optional description, data type (text, integer, boolean, date, float), initial value, and the target…
6 properties
4 required
VariableGroupBrief
object
Brief reference to a variable group included in list responses, containing id and apiName.
3 properties
2 required
VariablesInvalidDataGenericError
object
Generic invalid data response with standard error structure. Includes code INVALIDDATA and validation details.
4 properties
4 required
VariablesDuplicateDataExtendedError
object
Duplicate data error with extended validation details. Includes code DUPLICATEDATA, detailed context, message, and status.
4 properties
4 required
VariablesBatchUpdateRequestAlt1
object
Alternate instance of the batch update request wrapper holding an array of variable update items.
1 property
1 required
VariablesScopedRemovalResponse
object
Success response summarizing outcomes of variable removal within a scoped context, with per-item results.
1 property
VariablesListResponse
object
Response wrapper containing an array of variables returned by the list operation.
1 property
1 required
VariableGroupSummary_2
object
Compact representation of a variable group in read responses, including id and apiName.
2 properties
2 required
ScopedVariableUpdateItem
object
Object used to update a variable's value within a scoped resource context; accepts id or rid and the new value.
3 properties
VariablesDomainNotSupportedError
object
Returned when the operation is not supported for the selected domain. Includes code INVALIDDATA and validation details.
4 properties
4 required
VariablesRequestBodyMissingError
object
Error returned when the request body is missing. Includes code INVALIDDATA, validation details, message, and error status.
4 properties
4 required
InvalidRequestMethodError_2
object
Returned when an unsupported HTTP request method is used. Includes code INVALIDREQUESTMETHOD.
4 properties
4 required
VariableGroupAmbiguityError
object
Error payload indicating ambiguity while processing variable group identifiers, such as conflicting id and rid references.
4 properties
4 required
VariablesBatchUpdateResponse
object
Success response summarizing the outcome of a batch update, with an array of per-item operation results.
1 property
VariablesInvalidTypeError
object
Indicates an invalid data type for the variables field. Includes code INVALIDDATA and validation details.
4 properties
4 required
VariablesMandatoryFieldMissingError
object
Error for a missing required field in the payload. Includes code MANDATORYNOTFOUND and validation details.
4 properties
4 required
VariablesInvalidDataError
object
Generic invalid data error for the submitted payload. Includes code INVALIDDATA, details, message, and status.
4 properties
4 required
VariableGroupInvalidIDError
object
Indicates an invalid variable group identifier in the request path. Includes code INVALIDDATA and validation details.
4 properties
4 required
VariableRidInvalidParameterError
object
Error payload returned when the rid parameter is invalid for deletion of variables.
4 properties
4 required
VariablesBatchOperationCreated
object
Summary response for a batch variables operation where all items are created successfully. Includes an array of per-item results.
1 property
VariablesBatchInput
object
Request body wrapper that carries an array of variable definitions to be processed in a single batch.
1 property
1 required
VariablesBatchOperationMultiStatus
object
Batch response indicating mixed successes and failures. Contains a variables array with per-item outcomes and related details.
1 property
VariableResource
object
Full read model for a variable, including apiName, name, description, id, source, type, value, and its variable group summary.
9 properties
8 required
InvalidResourceIdError
object
Indicates an invalid identifier in the request URL. Includes code INVALIDDATA and contextual details.
4 properties
4 required
VariableListItem
object
Representation of a variable within collection responses, including readOnly, apiName, name, description, id, source, type, value, and group brief.
10 properties
9 required
VariablesScopedBatchUpdateRequestAlt1
object
Alternate instance of the scoped batch update request wrapper for variable updates.
1 property
1 required
VariableGroupInvalidRidQueryError
object
Error payload returned when the provided grouprid query parameter is invalid.
4 properties
4 required
VariablesInvalidDataGeneralError
object
Another form of invalid data error with validation details. Includes code INVALIDDATA and message.
4 properties
4 required
VariableGroupIdentifierInput
object
Nested object that identifies the variable group when defining a variable. Includes the group's id (required) and rid (UUID) if available.
2 properties
1 required
VariablesInvalidDataTypeError
object
General invalid data type error with validation details. Includes code INVALIDDATA and a descriptive message.
4 properties
4 required
VariablesScopedBatchUpdateResponse
object
Success response summarizing scoped batch updates with an array of per-item operation results.
1 property
VariableResultDetails
object
Details of an individual variable operation result, including the id of the affected variable.
4 properties
VariablesbyGroupResponse
object
Collection wrapper returning variables associated with the specified group identifier.
1 property
1 required
VariablesDuplicateDataError
object
Indicates that submitted data duplicates existing records. Includes code DUPLICATEDATA, details, message, and status.
4 properties
4 required
VariablesRequiredFieldMissingError
object
Error returned when the required variables field is not provided. Includes code MANDATORYNOTFOUND and validation details.
4 properties
4 required
VariableGroupInvalidReferenceError
object
Error payload returned when the supplied variable group identifier (id or rid) is invalid during variable processing.
4 properties
4 required
VariableGroupQueryAmbiguityError
object
Error payload for ambiguous query parameters where group and grouprid are both supplied or conflict.
4 properties
4 required
UnsubscribeLinkModifiedByUserDetail
object
Modifier user details returned by the unsubscribe link detail endpoint.
2 properties
2 required
GeneratedSchema1_4
Operation-specific schema for POST
RetrieveUnsubscribeLinksResponse
object
Response payload containing unsubscribe links upon successfully executing the designated API route GET request.
1 property
1 required
GeneralInvalidDataError
object
General response for invalid data errors across different fields or operations, providing error code and detailed messages.
4 properties
4 required
UpdateUnsubscribeLinksSuccessResponse
object
A successful response for a PUT request outlining the modified unsubscribe link configuration details.
1 property
UnsubscribeLinkAssociatedPlace
object
A place where the unsubscribe link is associated, including the linked resource, details, and type.
3 properties
3 required
UnsubscribeLinkModifiedByUser
object
User who last modified the unsubscribe link, including name and id.
2 properties
2 required
PermissionDeniedError_2
object
Error response indicating that permission is denied, including error code, message, and detailed validation information.
4 properties
4 required
UnsubscribeLinkAssociationModule
object
Module information relevant to an unsubscribe link association, including API name and id.
2 properties
2 required
RequestBodyNotFoundError
object
Error indicating that the request body was not found, including error code, status, and a detailed message.
4 properties
4 required
UnsubscribeLinkCreatedByUserDetail
object
Creator user details returned by the unsubscribe link detail endpoint.
2 properties
2 required
UnsubscribeLinkAssociationRecord
object
Association record that groups related associated places under a specific association id.
2 properties
2 required
UnsubscribeLinkAssociationResource
object
Resource associated with an unsubscribe link, including its id and name.
2 properties
2 required
UnsubscribeLinkSummaryRecord
object
Summarized unsubscribe link configuration with timestamps, page settings, submission behavior, and creator/modifier references as returned by the listing endpo…
12 properties
12 required
RequiredFieldDependencyError
object
Error indicating that a necessary dependent field is missing, offering details about failed checks and requirements.
4 properties
4 required
MandatoryFieldMissingError_2
object
Error response for a missing mandatory field, including code and detailed validation information for data errors.
4 properties
4 required
DependentFieldMissingError_2
object
Response indicating a missing dependent field requirement for an operation, with details about the failing condition.
4 properties
4 required
InvalidUnsubscribeLinkIdError
object
Error indicating an invalid ID for an unsubscribe link not being a part of the organization, with ample descriptive details.
4 properties
4 required
UpdateUnsubscribeLinksRequest
object
Body schema for PUT requests proposing updates to unsubscribe link configurations, demanding detailed entries across fields.
1 property
1 required
UnsubscribeLinkModificationByIdRequest
object
Request payload to modify an unsubscribe link identified by its id.
1 property
1 required
CreateUnsubscribeLinksSuccessResponse
object
A success response for a POST request that describes the newly created unsubscribe links.
1 property
InvalidDataValueErrorAlt
object
Alternate invalid data error used for unsubscribe link validation failures.
4 properties
4 required
ErrorResponseCore1_3
object
unsupported value found for the field pagetype
4 properties
4 required
GeneratedSchema2_3
object
Base schema for array items
8 properties
UnsubscribeLinkCreatedByUser
object
User who created the unsubscribe link, including name and id.
2 properties
2 required
UnsubscribeLinksResponse
object
Envelope containing a collection of unsubscribe link records returned by the settings listing endpoint.
1 property
1 required
UnsubscribeLinkActionStatus
object
Status of an unsubscribe link operation, including outcome code, message, and the affected entity reference.
4 properties
FetchAssociatedPlacesResponse
object
Response output highlighting associated places compiled upon DELETE request execution on outlined setting routes.
1 property
1 required
UnsubscribeLinkModificationResultList
object
Collection of action results produced after modifying unsubscribe links.
1 property
ActionEntityReference
object
Reference to the entity affected by an operation, containing its unique identifier.
1 property
MissingFieldError
object
Error showing a missing required field, with complete error details including error code and a message describing the issue.
4 properties
4 required
InvalidDataErrorType
object
This error tackles invalid data errors, offering crucial insights via error codes and detailed validation info.
4 properties
4 required
GenericInvalidDataError
object
A broad type of error regarding invalid data entries, which shows detailed validation issues encountered.
4 properties
4 required
InvalidDataTypeError
object
Error occurring due to invalid data type provided for a field, including detailed information about the validation error.
4 properties
4 required
GeneratedSchema3_4
Operation-specific schema for PUT
UnsubscribeLinkRemovalResultList
object
Collection of action results produced after deleting unsubscribe links.
1 property
LinkLimitExceededError
object
Error showcasing that the allowed limit for creating unsubscribe links has been exceeded, along with necessary details.
4 properties
4 required
DuplicateDataError
object
Response error indicating that the data trying to be entered is duplicate, such as already existing unsubscribe link names.
4 properties
4 required
UnsubscribeLinkAssociationDetails
object
Additional details for an unsubscribe link association, such as module context.
1 property
1 required
UnsubscribeLinkDetailRecord
object
Full unsubscribe link configuration with display messages, submission behavior, and audit information.
12 properties
12 required
GeneratedSchema_4
Operation-specific schema for PUT
InitiateUnsubscribeLinksRequest
object
Request payload to create one or more unsubscribe links.
1 property
1 required
InvalidCustomLocationURLError
object
Response for a POST request indicating that the custom location URL data provided is invalid.
4 properties
4 required
PosttagsRequest
object
Request body schema
1 property
1 required
TagsNested1
object
Nested schema for tags
4 properties
ErrorResponseCore393894623
object
When Tags module limit exceeded
4 properties
4 required
ErrorResponseCore491436158
object
When mandatory data is not provided
4 properties
4 required
ErrorResponseCoreInvalidData
object
When invalid color code is given
4 properties
4 required
GETTagsNested
object
Nested schema for tags
7 properties
7 required
TagsNested
object
Root key
2 properties
1 required
ErrorResponseCore1335454202
object
This error will be thrown when a invalid module is given
4 properties
4 required
GettagsResponse200
object
Success Response of Tags Get api
2 properties
2 required
ErrorResponseCore1875045219
object
When invalid request method is given
4 properties
4 required
ErrorResponseCore1161913208
object
When Tag read permission is not available.
4 properties
4 required
DeletetagsResponse200
object
Success response of Tags delete
1 property
ErrorResponseCore987684789
object
When invalid tag id is given
4 properties
4 required
PosttagsResponse201
object
Success response for Tags Creation
1 property
ErrorResponseCore767063671
object
When a invalid URL Pattern is given
4 properties
4 required
ErrorResponseCore62955412
object
Missing required parameter: id
4 properties
4 required
PuttagsResponse200
object
Success Response when Tags update success
1 property
ErrorResponseCore1241530911
object
Missing required parameter: module
4 properties
4 required
GETModifiedByNested
object
Nested schema for modifiedby
2 properties
2 required
ErrorResponseCore1381982232
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
ErrorResponseCore1093417477
object
Auto-generated from ApiDefinition for MANDATORYNOTFOUND
4 properties
4 required
GETInfoNested
object
Nested schema for info
3 properties
2 required
DetailsNested_2
object
Nested schema for details
7 properties
ErrorResponseCore619698125
object
When invalid color code is given
4 properties
4 required
PuttagsRequest
object
Request body schema
1 property
1 required
ErrorResponseCore501721585
object
Auto-generated from 207 Multi-Status error item
4 properties
4 required
GETCreatedByNested
object
Nested schema for createdby
2 properties
2 required
Post207multistatusResponse207
object
Generated schema for tagsSuccess
4 properties
ErrorResponseCore1273605641
object
When the given module name is valid, but does not support Tags
4 properties
4 required
ErrorResponseCore239878082
object
Auto-generated from ApiDefinition for INVALIDDATA
4 properties
4 required
IdDetails
object
Error details with validation information
1 property
1 required
ApiNameExistsInJsonPath
object
Already used details object
3 properties
3 required
ModifierInfo
objectnull
Information about the last person who modified a record, including name and identifier.
2 properties
ParamNameDetails
object
Details with paramname
1 property
1 required
ParamNameWithEnumDetails
object
Details with paramname
1 property
1 required
CadenceID
string
ID of the cadence
ModuleInformation
object
Details about an automation module, including its API name and unique identifier.
2 properties
DependencyFieldMissingDetails
object
Details of dependency field missing error
4 properties
1 required
CreatorInfo
object
Information about the creator of a record, including name and identifier.
2 properties
ExecuteEvery
objectnull
cadence executeevery
2 properties
1 required
MandatoryInvalidDataCommonApiNameJsonPath
object
Details of field not found error
3 properties
2 required
ResourcePathIndex
object
Error details with validation information
1 property
1 required
ApiNameLimitJsonPath
object
Error details with validation information
3 properties
3 required
InvalidDataWithId
object
Details of invalid data error
3 properties
3 required
InvalidDataWithSupportedValues
object
Details of invalid data error
4 properties
3 required
CadenceName
string
Name of the cadence
InvalidDataWithDataTypeAndSupportedValues
object
Details of invalid data error
5 properties
2 required
ExpectedFieldMissingDetails
object
Details of expected fields missing error
1 property
1 required
CreatedTime_2
string
Cadence creation time in ISO 8601 format
ExpectedDependentFieldMissingDetails
object
Details of expected fields missing error
2 properties
2 required
AmbiguityDetails
object
Ambiguity due to
1 property
1 required
DependentMismatchDetails
object
Details of dependent mismatch error
5 properties
2 required
AllErrorResponse
object
Error Response
4 properties
4 required
MaximumLengthApiNameJsonPath
object
Invalid data error response
3 properties
3 required
ApiNameLimit
object
Error details with validation information
2 properties
1 required
EmptyDetails
object
Empty details object
CadenceDescription
string
Description of the cadence
CustomViewInfo
objectnull
Details of a custom view, including name and identifier.
2 properties
FollowUpSummary
object
A summary of follow-up actions including counts of WhatsApp, task, call, and email follow-ups.
4 properties
DetailsPermission
object
Error details with validation information
1 property
1 required
InvalidDataWithDataType
object
Details of invalid data error
4 properties
1 required
NotSupportedForCriteriaOnModuleDisable
object
Schema for error responses returned during territory creation or update.
1 property
InvalidDataWithMaximumLength
object
Schema for error responses returned during territory creation or update.
1 property
1 required
MandatoryNotFoundError
object
Schema for error responses returned during territory creation or update.
1 property
1 required
DependentFieldMissingErrorInURL
object
Schema for error responses returned during territory creation or update.
1 property
1 required
TerritoryMaxLimitExceededErrorSchema
object
A object value.
1 property
1 required
TerritoryGETSchema
object
The items field of type object.
14 properties
11 required
CriteriaObject
object
criteria schema for post
3 properties
GroupCriteriaPOST
object
Schema for GroupCriteriaPOST.
2 properties
ManagerSchema
DependentFieldMissingError_3
object
Schema for error responses returned during territory creation or update.
1 property
1 required
NotAllowedOrgTerritoryUpdate
object
Schema for error responses returned during territory creation or update.
1 property
1 required
TerritoryGetByIdSchema
object
A object value.
1 property
1 required
InvalidDataWithId_2
object
Schema for error responses returned during territory creation or update.
1 property
1 required
InvalidDataWithSupportedValues_2
object
Schema for error responses returned during territory creation or update.
1 property
1 required
TerritoryMaxLimitExceededErrorSchemaForCriteria
object
A object value.
1 property
1 required
UserIdObject
object
The modifiedby property.
2 properties
2 required
TerritorySuccessResponse
object
Schema representing the API response for territory creation.
1 property
1 required
GroupCriteriaGET
object
Schema for GroupCriteriaGET.
2 properties
2 required
NotAllowedDeleteErrorResponse
object
Schema for error responses returned during territory creation or update.
1 property
1 required
PermissionDeniedWithoutId
object
Schema for error responses returned during territory creation or update.
4 properties
4 required
PermissionDeniedOrgTerritory
object
Schema for error responses returned during territory creation or update.
4 properties
4 required
DuplicateDataError_2
object
Schema for error responses returned during territory creation or update.
1 property
1 required
ReportingToSchema
RequiredParamMissing
object
Schema for error responses returned during territory creation or update.
4 properties
4 required
InvalidData
object
Schema for error responses returned during territory creation or update.
1 property
1 required
NotSupportedFieldsInFilters
object
Schema for error responses returned during territory creation or update.
4 properties
4 required
TerritoryInvalidUrlPathErrorSchema
object
A object value.
4 properties
4 required
InfoSchema
object
The info property.
4 properties
4 required
TerritoryErrorPermissionDenied_2
object
A object value.
4 properties
4 required
PipelineUpdateRequestUrl
object
Request body for updating or creating pipeline configurations with custom picklist values and stage mappings.
1 property
1 required
PipelineGetErrorResponse
object
Standard error response format used across API endpoints for validation and business logic errors.
4 properties
4 required
PipelineUpdateOrDeleteErrorResponse
object
Batch error response for pipeline operations maintaining 1:1 correspondence with request items when validation fails.
1 property
1 required
PipelineUpdateRequest
object
Request body for updating or creating pipeline configurations with custom picklist values and stage mappings.
1 property
1 required
NoPermissionErrorResponse_2
object
No permission for create/update/delete pipeline error response
4 properties
PipelineUpdateOrDeleteUrlErrorResponse
object
Invalid pipeline error response
4 properties
PipelineCreateRequest
object
Request body for updating or creating pipeline configurations with custom picklist values and stage mappings.
1 property
1 required
PipelineTransferResponse
object
Response confirming pipeline transfer operation with source-to-target mappings for pipeline and stages.
1 property
1 required
PipelineGetResponse
object
Root response object containing an array of pipeline configurations from Zoho CRM.
1 property
1 required
PipelineTransferErrorResponse
object
Batch error response for pipeline transfer operations with detailed validation failure information.
1 property
1 required
PipelineTransferSuccessResponse
object
Success response for pipeline transfer scheduling operation with job tracking information.
1 property
1 required
PipelineSuccessResponse
object
Batch success response for pipeline creation/update operations, maintaining 1:1 correspondence with request items.
1 property
1 required
SinglePipelineGetResponse
object
Root response object containing an array of pipeline configurations from Zoho CRM.
1 property
1 required
PipelineCreateErrorResponse
object
Batch error response for pipeline operations maintaining 1:1 correspondence with request items when validation fails.
1 property
1 required
MaximumLengthErrorResponse
object
Error response when maximum length constraint is violated.
4 properties
4 required
UrlErrorResponseForCustomView
object
Common Error Response
4 properties
1 required
UserReference_3
object
user-details object
2 properties
2 required
MandatoryNotFoundForSort
object
Mandatory field not found error details for sort field or order
4 properties
SimpleFilterCriterionValueObjectResponse
Lookup object value for filter criteria
SimpleFilterCriterionResponse
object
Simple field-based filter criterion with single field, comparator, and value
5 properties
3 required
CustomViewGetItem
object
Custom View GET Item
25 properties
ModuleReference
object
Module information
2 properties
SimpleFilterCriterionValueNumber
number
Numeric value for number field options.
SharedTo
arraynull
Information about users/groups the Custom View is shared with
SimpleFieldError
object
Error caused by an invalid or missing field.
2 properties
2 required
ResourcePathIndexError
object
Indicates that a specific segment of the resource path or URL is invalid.
1 property
1 required
SimpleFilterCriterionRequest
object
Simple field-based filter criterion with single field, comparator, and value
4 properties
3 required
SimpleFilterCriterionValueBoolean
boolean
Boolean value for checkbox field options.
ModuleForbiddenErrorResponse
object
Response returned when the user does not have required permissions
4 properties
4 required
CustomViewSortByIdFailureDetails
object
Custom view sort failure details response schema
1 property
FieldReference_2
object
field of customview
2 properties
CustomViewSortFailureItem
Custom view failure item
SimpleFilterCriterionValueString
string
String value for picklist/text/tag options.
FilterCriterionResponse
object
Filter criteria for data selection supporting both simple field-based filters and complex grouped filters with logical operators
InvalidDataSort
object
Invalid data error details for sort field or order
4 properties
SimpleFilterCriterionValueObjectRequest
Lookup object value for filter criteria
CustomViewSortByIdFailureItem
Custom view failure item
FilterFieldBase
object
Field reference for filter operations with minimal required properties
2 properties
CustomViewUpdateSuccess
object
Response schema for successful custom view update operation.
4 properties
GroupedFilterCriterionResponse
object
Grouped filter criterion containing multiple filter conditions with logical operators for complex filtering logic
3 properties
2 required
GroupedFilterCriterionRequest
object
Grouped filter criterion containing multiple filter conditions with logical operators for complex filtering logic
2 properties
2 required
InvalidDataSortById
object
Invalid data error details for sort field or order by ID
4 properties
CustomViewField
array
Fields included in the Custom View
CustomViewUpdateSuccessResponse
object
Bulk update success response schema
1 property
1 required
CustomViewInfo_2
object
Info object containing translations
6 properties
RequiredParameterMissingResponse
object
Error responses for missing required parameters
4 properties
4 required
CustomViewSortFailureDetails
object
Custom view sort failure details response schema
1 property
SimpleFilterCriterionValueObjectBase
object
Base minified record of the lookup module.
2 properties
FilterCriterionRequest
object
Filter criteria for data selection supporting both simple field-based filters and complex grouped filters with logical operators
FieldMappingForRead
array
Fieldmappingforread field.
Module
object
Module field.
2 properties
2 required
GETWorkflowTagactionrecordsNested
object
Nested schema for workflowtagActionRecords
3 properties
3 required
ErrorResponseCore1335454202_2
object
When the given module name is invalid
4 properties
4 required
TagsNested_2
object
root key
4 properties
GETAddtagsNested1
object
Nested schema for AddTags
3 properties
3 required
ErrorResponseTagIdNotFound
object
When the given module name is invalid
4 properties
4 required
GETRemovetagsNested1
object
Nested schema for RemoveTags
3 properties
3 required
GETBlueprintNested
object
Nested schema for Blueprint
1 property
1 required
PostmergeResponse200
object
success response when tags merged successfully
1 property
GETConfiguredAreasNested
object
Nested schema for configuredareas
2 properties
2 required
GETCustomViewNested
object
Nested schema for customview
4 properties
4 required
GETRemovetagsNested
object
Nested schema for RemoveTags
3 properties
3 required
ErrorResponseCore833637355
object
When tag given in invalid data type
4 properties
4 required
GETAddtagsNested2
object
Nested schema for AddTags
3 properties
3 required
ErrorResponseCore1161913208_2
object
When permission doesn't exists
4 properties
4 required
GETAddtagsNested
object
Nested schema for AddTags
3 properties
3 required
TagsNested2
object
Nested schema for tags
4 properties
GETWorkflowNested
object
Nested schema for Workflow
1 property
1 required
GETRemovetagsNested2
object
Nested schema for RemoveTags
3 properties
3 required
GET3060320000000666022Nested
object
Nested schema for 3060320000000666022
2 properties
2 required
ErrorResponseCore94581445
object
Missing required parameter: module
4 properties
4 required
TagErrorItemResponse
object
Error object for individual tag failures
4 properties
4 required
GET3060320000000666022Nested1
object
Nested schema for 3060320000000666022
2 properties
2 required
GETRulesNested1
object
Nested schema for rules
8 properties
8 required
GETRulesNested2
object
Nested schema for rules
7 properties
7 required
GETRulesNested
object
Nested schema for rules
9 properties
9 required
PostmergeRequest
object
Request body schema
1 property
1 required
GET3060320000000666022Nested2
object
Nested schema for 3060320000000666022
2 properties
2 required
GetrecordscountResponse200
object
success response of recordscount api
2 properties
1 required
DetailsNested2
object
Nested schema for details
6 properties
ErrorResponseCore1273605641_2
object
When the module name is valid but that doesn't have tags support
4 properties
4 required
GETOrchestrationNested
object
Nested schema for Orchestration
1 property
1 required
GroupedFilterCriterionRequest_2
object
Grouped filter criterion containing multiple filter conditions with logical operators for complex filtering logic
2 properties
2 required
SimpleFilterCriterionResponse_2
object
Simple field-based filter criterion with single field, comparator, and value
4 properties
3 required
SimpleFilterCriterionRequest_2
object
Simple field-based filter criterion with single field, comparator, and value
4 properties
3 required
GroupedFilterCriterionResponse_2
object
Grouped filter criterion containing multiple filter conditions with logical operators for complex filtering logic
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoho 12
Other APIs Zoho publishes across the network.
Zoho Inventory
Zoho Books
Zoho Invoice
Zoho Billing
Zoho Expense
Zoho People
Zoho Recruit
Zoho Projects
Zoho Mail
Zoho Sign
Zoho Campaigns
Zoho SalesIQ
#Settings