Cadences v8 OAS. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 1 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Cadences",
"description": "Cadences v8 OAS",
"version": "8"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"description": "API Server URL TLD",
"default": "com",
"enum": [
"eu",
"com",
"au",
"in",
"jp",
"cn",
"ca"
]
},
"version": {
"description": "API Version",
"default": "v8"
}
}
}
],
"paths": {
"/settings/automation/cadences": {
"get": {
"operationId": "getCadences",
"summary": "GET - Get all cadences",
"description": "Get all cadences",
"parameters": [
{
"name": "module",
"in": "query",
"required": false,
"description": "Cadence supported modules like Leads, Contacts, Accounts, Deals, Quotes, Vendors or custom module",
"schema": {
"type": "string",
"maxLength": 255
}
},
{
"name": "name",
"in": "query",
"description": "Filters by cadence name",
"schema": {
"type": "string",
"maxLength": 100
}
},
{
"name": "active",
"in": "query",
"description": "Filters by cadence active status. Use true or false",
"schema": {
"type": "boolean"
}
},
{
"name": "fields",
"in": "query",
"description": "Filters by fields. Use name",
"schema": {
"type": "string",
"enum": [
"name"
]
}
},
{
"$ref": "#/components/parameters/ParamQueryPage"
},
{
"$ref": "#/components/parameters/ParamQueryPerPage"
}
],
"responses": {
"200": {
"description": "Cadence retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Response schema for getting all cadences",
"properties": {
"cadences": {
"type": "array",
"description": "List of cadences",
"items": {
"type": "object",
"description": "Cadence details",
"properties": {
"summary": {
"$ref": "#/components/schemas/FollowUpSummary"
},
"description": {
"$ref": "#/components/schemas/CadenceDescription"
},
"created_time": {
"$ref": "#/components/schemas/CreatedTime"
},
"module": {
"$ref": "#/components/schemas/ModuleInformation"
},
"active": {
"type": "boolean",
"description": "Indicates if the cadence is active"
},
"execution_details": {
"type": [
"object",
"null"
],
"description": "Details about cadence execution",
"properties": {
"unenroll_properties": {
"type": "object",
"description": "Properties for automatic unenrollment from the cadence",
"properties": {
"end_date": {
"type": "string",
"description": "End date for unenrollment",
"maxLength": 50
},
"type": {
"type": [
"string",
"null"
],
"description": "Type of unenrollment",
"maxLength": 255
}
},
"additionalProperties": false
},
"end_date": {
"type": "string",
"description": "End date for cadence execution",
"maxLength": 50
},
"automatic_unenroll": {
"type": "boolean",
"description": "Indicates if automatic unenrollment is enabled"
},
"type": {
"type": [
"string",
"null"
],
"description": "Type of execution",
"maxLength": 255
},
"execute_every": {
"$ref": "#/components/schemas/ExecuteEvery"
}
},
"additionalProperties": false
},
"published": {
"type": "boolean",
"description": "Indicates if the cadence is published"
},
"type": {
"type": "string",
"enum": [
"custom_view",
"manual_enrollment"
],
"description": "Type of cadence enrollment"
},
"created_by": {
"$ref": "#/components/schemas/CreatorInfo"
},
"modified_time": {
"type": [
"string",
"null"
],
"description": "Cadence last modification time in ISO 8601 format",
"format": "date-time"
},
"name": {
"$ref": "#/components/schemas/CadenceName"
},
"modified_by": {
"$ref": "#/components/schemas/ModifierInfo"
},
"id": {
"$ref": "#/components/schemas/CadenceID"
},
"custom_view": {
"$ref": "#/components/schemas/CustomViewInfo"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive",
"draft"
],
"description": "Current status of the cadence"
}
},
"additionalProperties": false
},
"maxItems": 400
},
"info": {
"type": "object",
"description": "Information about the pagination",
"properties": {
"per_page": {
"type": "integer",
"format": "int32",
"description": "Number of cadences per page"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Total number of cadences retrieved"
},
"page": {
"type": "integer",
"format": "int32",
"description": "Current page number"
},
"more_records": {
"type": "boolean",
"description": "Indicates if more records are available beyond the current page"
}
},
"additionalProperties": false
}
},
"required": [
"cadences",
"info"
],
"additionalProperties": false
}
}
}
},
"204": {
"description": "No cadence configured to retrieve"
},
"400": {
"description": "Module not supported or invalid module name",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Invalid module name",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_DATA",
"PATTERN_NOT_MATCHED",
"UNABLE_TO_PARSE_DATA_TYPE",
"INVALID_REQUEST"
]
},
"details": {
"type": "object",
"description": "Details of the parameter causing the error",
"properties": {
"param_name": {
"type": "string",
"description": "name of the parameter causing the error",
"maxLength": 255
}
},
"additionalProperties": false
},
"message": {
"type": "string",
"description": "Error message describing the issue",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"additionalProperties": false
}
}
}
},
"403": {
"description": "API not supported for selected domains",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllErrorResponse"
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.cadences.READ"
]
}
]
}
},
"/settings/automation/cadences/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Cadence id in url path",
"schema": {
"type": "string",
"maxLength": 255
}
}
]
},
"/settings/automation/cadences/{id}/actions/clone": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Cadence id in url path",
"schema": {
"type": "string",
"maxLength": 255
}
}
]
},
"/settings/automation/cadences/{id}/actions/activate": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Cadence id in url path",
"schema": {
"type": "string",
"maxLength": 255
}
}
]
},
"/settings/automation/cadences/{id}/actions/deactivate": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Cadence id in url path",
"schema": {
"type": "string",
"maxLength": 255
}
}
]
},
"/settings/automation/cadences/{id}/actions/publish": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Cadence id in url path",
"schema": {
"type": "string",
"maxLength": 255
}
}
]
}
},
"components": {
"schemas": {
"FollowUpSummary": {
"type": "object",
"additionalProperties": false,
"description": "A summary of follow-up actions including counts of WhatsApp, task, call, and email follow-ups.",
"properties": {
"whatsapp_follow_up_count": {
"type": "integer",
"format": "int32",
"description": "Number of WhatsApp follow-ups"
},
"task_follow_up_count": {
"type": "integer",
"format": "int32",
"description": "Number of task follow-ups"
},
"call_follow_up_count": {
"type": "integer",
"format": "int32",
"description": "Number of call follow-ups"
},
"email_follow_up_count": {
"type": "integer",
"format": "int32",
"description": "Number of email follow-ups"
}
},
"title": "Follow-Up Summary"
},
"CadenceName": {
"type": "string",
"maxLength": 100,
"description": "Name of the cadence"
},
"CadenceID": {
"type": "string",
"maxLength": 255,
"description": "ID of the cadence"
},
"CreatedTime": {
"type": "string",
"format": "date-time",
"description": "Cadence creation time in ISO 8601 format"
},
"CadenceDescription": {
"type": "string",
"maxLength": 500,
"description": "Description of the cadence"
},
"ModuleInformation": {
"type": "object",
"additionalProperties": false,
"description": "Details about an automation module, including its API name and unique identifier.",
"properties": {
"api_name": {
"type": "string",
"maxLength": 255,
"description": "API name of the module"
},
"id": {
"type": "string",
"maxLength": 255,
"description": "ID of the module"
}
},
"title": "Module Information"
},
"ModifierInfo": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"description": "Information about the last person who modified a record, including name and identifier.",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of the modifier"
},
"id": {
"type": "string",
"maxLength": 255,
"description": "ID of the modifier"
}
},
"title": "Modifier Information"
},
"CustomViewInfo": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"description": "Details of a custom view, including name and identifier.",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of the custom view"
},
"id": {
"type": "string",
"maxLength": 255,
"description": "ID of the custom view"
}
},
"title": "Custom View Information"
},
"CreatorInfo": {
"type": "object",
"additionalProperties": false,
"description": "Information about the creator of a record, including name and identifier.",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of the creator"
},
"id": {
"type": "string",
"maxLength": 255,
"description": "ID of the creator"
}
},
"title": "Creator Information"
},
"ExecuteEvery": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"description": "cadence execute_every",
"properties": {
"period": {
"type": "string",
"description": "Cadence execute_every period (Required)",
"enum": [
"immediately",
"hours",
"days",
"weeks"
]
},
"unit": {
"type": "integer",
"format": "int32",
"description": "Cadence execute_every unit"
}
},
"required": [
"period"
]
},
"AllErrorResponse": {
"type": "object",
"description": "Error Response",
"required": [
"code",
"message",
"status",
"details"
],
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"EXPECTED_FIELD_MISSING",
"INVALID_DATA",
"MANDATORY_NOT_FOUND",
"DEPENDENT_MISMATCH",
"NOT_ALLOWED",
"NO_PERMISSION",
"ALREADY_ACTIVATED",
"ALREADY_DEACTIVATED",
"LIMIT_EXCEEDED",
"NOT_SUPPORTED",
"DEPENDENT_FIELD_MISSING",
"AMBIGUITY_DURING_PROCESSING",
"EXPECTED_DEPENDENT_FIELD_MISSING",
"ALREADY_USED",
"DUPLICATE_DATA",
"INVALID_MODULE",
"REQUIRED_PARAM_MISSING",
"DEPENDENT_PARAM_MISSING"
]
},
"message": {
"type": "string",
"description": "Error message",
"format": "error message"
},
"status": {
"type": "string",
"const": "error",
"description": "Error status"
},
"details": {
"oneOf": [
{
"$ref": "#/components/schemas/ExpectedFieldMissingDetails"
},
{
"$ref": "#/components/schemas/ExpectedDependentFieldMissingDetails"
},
{
"$ref": "#/components/schemas/InvalidDataWithId"
},
{
"$ref": "#/components/schemas/InvalidDataWithSupportedValues"
},
{
"$ref": "#/components/schemas/InvalidDataWithDataType"
},
{
"$ref": "#/components/schemas/InvalidDataWithDataTypeAndSupportedValues"
},
{
"$ref": "#/components/schemas/MandatoryInvalidDataCommonApiNameJsonPath"
},
{
"$ref": "#/components/schemas/DependentMismatchDetails"
},
{
"$ref": "#/components/schemas/DependencyFieldMissingDetails"
},
{
"$ref": "#/components/schemas/ResourcePathIndex"
},
{
"$ref": "#/components/schemas/IdDetails"
},
{
"$ref": "#/components/schemas/ParamNameDetails"
},
{
"$ref": "#/components/schemas/ParamNameWithEnumDetails"
},
{
"$ref": "#/components/schemas/ApiNameLimit"
},
{
"$ref": "#/components/schemas/DetailsPermission"
},
{
"$ref": "#/components/schemas/EmptyDetails"
},
{
"$ref": "#/components/schemas/ApiNameLimitJsonPath"
},
{
"$ref": "#/components/schemas/AmbiguityDetails"
},
{
"$ref": "#/components/schemas/ApiNameExistsInJsonPath"
},
{
"$ref": "#/components/schemas/MaximumLengthApiNameJsonPath"
}
]
}
},
"additionalProperties": false
},
"ExpectedFieldMissingDetails": {
"type": "object",
"description": "Details of expected fields missing error",
"properties": {
"expected_fields": {
"type": "array",
"description": "List of expected fields that are missing",
"items": {
"type": "object",
"description": "Expected field object",
"required": [
"api_name",
"json_path"
],
"properties": {
"api_name": {
"type": "string",
"description": "API name of the expected field",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "JSON path of the expected field",
"maxLength": 500
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"required": [
"expected_fields"
],
"additionalProperties": false
},
"ExpectedDependentFieldMissingDetails": {
"type": "object",
"description": "Details of expected fields missing error",
"properties": {
"dependee": {
"type": "object",
"description": "Expected field object",
"required": [
"api_name",
"json_path"
],
"properties": {
"api_name": {
"type": "string",
"description": "API name of the expected field",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "JSON path of the expected field",
"maxLength": 500
}
},
"additionalProperties": false
},
"expected_fields": {
"type": "array",
"description": "List of expected fields that are missing",
"items": {
"type": "object",
"description": "Expected field object",
"required": [
"api_name",
"json_path"
],
"properties": {
"api_name": {
"type": "string",
"description": "API name of the expected field",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "JSON path of the expected field",
"maxLength": 500
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"required": [
"dependee",
"expected_fields"
],
"additionalProperties": false
},
"InvalidDataWithDataType": {
"type": "object",
"description": "Details of invalid data error",
"properties": {
"expected_data_type": {
"type": "string",
"description": "Expected data type for the field",
"maxLength": 255
},
"api_name": {
"type": "string",
"description": "API name of the field",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "JSON path of the field",
"maxLength": 500
},
"param_name": {
"type": "string",
"description": "Parameter name where the error occurred",
"maxLength": 255
}
},
"required": [
"expected_data_type"
],
"additionalProperties": false
},
"InvalidDataWithSupportedValues": {
"type": "object",
"description": "Details of invalid data error",
"properties": {
"supported_values": {
"type": "array",
"description": "Supported values for the field",
"items": {
"type": "string",
"description": "Supported value",
"maxLength": 500
},
"maxItems": 25
},
"api_name": {
"type": "string",
"description": "API name of the field",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "JSON path of the field",
"maxLength": 500
},
"param_name": {
"type": "string",
"description": "Parameter name where the error occurred",
"maxLength": 255
}
},
"required": [
"supported_values",
"api_name",
"json_path"
],
"additionalProperties": false
},
"InvalidDataWithId": {
"type": "object",
"description": "Details of invalid data error",
"properties": {
"api_name": {
"type": "string",
"description": "API name of the field",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "JSON path of the field",
"maxLength": 500
},
"id": {
"type": "string",
"description": "Cadence id",
"maxLength": 255
}
},
"required": [
"api_name",
"json_path",
"id"
],
"additionalProperties": false
},
"InvalidDataWithDataTypeAndSupportedValues": {
"type": "object",
"description": "Details of invalid data error",
"properties": {
"expected_data_type": {
"type": "string",
"description": "Expected data type for the field",
"maxLength": 255
},
"supported_values": {
"type": "array",
"description": "Supported values for the field",
"items": {
"type": "string",
"description": "Supported value",
"maxLength": 500
},
"maxItems": 25
},
"api_name": {
"type": "string",
"description": "API name of the field",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "JSON path of the field",
"maxLength": 500
},
"param_name": {
"type": "string",
"description": "Parameter name where the error occurred",
"maxLength": 255
}
},
"required": [
"expected_data_type",
"supported_values"
],
"additionalProperties": false
},
"MandatoryInvalidDataCommonApiNameJsonPath": {
"type": "object",
"description": "Details of field not found error",
"properties": {
"api_name": {
"type": "string",
"description": "API name of field",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "JSON path of the field",
"maxLength": 500
},
"param_name": {
"type": "string",
"description": "Parameter name where the error occurred",
"maxLength": 255
}
},
"required": [
"api_name",
"json_path"
],
"additionalProperties": false
},
"DependentMismatchDetails": {
"type": "object",
"description": "Details of dependent mismatch error",
"properties": {
"dependee": {
"type": "object",
"description": "Detail field: dependee",
"required": [
"api_name",
"json_path"
],
"properties": {
"api_name": {
"type": "string",
"description": "Nested detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Nested detail field: json_path",
"maxLength": 500
}
},
"additionalProperties": false
},
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 500
},
"supported_values": {
"type": "array",
"description": "Detail field: supported_values",
"items": {
"type": "string",
"description": "Supported value",
"maxLength": 500
},
"maxItems": 25
},
"param_name": {
"type": "string",
"description": "Detail field: param_name",
"maxLength": 255
}
},
"required": [
"dependee",
"supported_values"
],
"additionalProperties": false
},
"DependencyFieldMissingDetails": {
"type": "object",
"description": "Details of dependency field missing error",
"properties": {
"dependee": {
"type": "object",
"description": "Detail field: dependee",
"properties": {
"api_name": {
"type": "string",
"description": "Nested detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Nested detail field: json_path",
"maxLength": 500
},
"param_name": {
"type": "string",
"description": "Detail field: param_name",
"maxLength": 255
}
},
"additionalProperties": false
},
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 500
},
"param_name": {
"type": "string",
"description": "Detail field: param_name",
"maxLength": 255
}
},
"required": [
"dependee"
],
"additionalProperties": false
},
"ResourcePathIndex": {
"type": "object",
"des
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-cadences-openapi.json