Unenroll cadence for record. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 2 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Cadence Execution",
"description": "Unenroll cadence for record",
"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": {
"/{module}/actions/unenrol_from_cadences": {
"post": {
"summary": "Unenroll records from cadences",
"description": "Un-Enroll records from the cadences",
"operationId": "postUnenrolFromCadences",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Leads.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Contacts.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Accounts.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Deals.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Tasks.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Events.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Calls.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Products.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Vendors.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Campaigns.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Cases.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Solutions.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Quotes.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Invoices.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Forecasts.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Activities.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Notes.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Attachments.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.custom.CREATE"
]
}
],
"parameters": [
{
"$ref": "#/components/parameters/Module"
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostCadencesRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostcadencesResponse200"
}
}
}
},
"207": {
"description": "Multi-Status — Response contains mixed status results",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostcadencesResponse207"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore260315750"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1243473672"
},
{
"$ref": "#/components/schemas/ErrorResponseCore814179042"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1362235056"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1414382895"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1137512454"
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponse403"
}
]
}
}
}
}
}
}
},
"/{module}/actions/enrol_in_cadences": {
"post": {
"summary": "Enroll records into cadences",
"description": "API to enroll records into manual cadence",
"operationId": "postEnrolInCadences",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Leads.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Contacts.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Accounts.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Deals.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Tasks.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Events.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Calls.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Products.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Vendors.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Campaigns.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Cases.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Solutions.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Quotes.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Invoices.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Forecasts.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Activities.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Notes.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.Attachments.CREATE"
]
},
{
"iam-oauth2-schema": [
"ZohoCRM.modules.custom.CREATE"
]
}
],
"parameters": [
{
"$ref": "#/components/parameters/Module"
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostCadencesRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostcadencesResponse200"
}
}
}
},
"207": {
"description": "Multi-Status — Response contains mixed status results",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostcadencesResponse207"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore260315750"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1243473672"
},
{
"$ref": "#/components/schemas/ErrorResponseCore814179042"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1362235056"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1414382895"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1137512454"
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponse403"
}
]
}
}
}
}
}
}
}
},
"components": {
"parameters": {
"Module": {
"name": "module",
"description": "Specifies the module name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"maxLength": 100
}
}
},
"schemas": {
"PostCadencesRequest": {
"type": "object",
"additionalProperties": false,
"description": "Request body schema",
"properties": {
"cadences_ids": {
"type": "array",
"description": "Cadence ids has to be given here (Required)",
"items": {
"type": "string",
"description": "cadence id",
"maxLength": 255
},
"maxItems": 5
},
"ids": {
"type": "array",
"description": "records ids to be enroll (Required)",
"items": {
"type": "string",
"description": "record id",
"maxLength": 255
},
"maxItems": 100
}
},
"required": [
"cadences_ids",
"ids"
]
},
"PostcadencesResponse200": {
"type": "object",
"additionalProperties": false,
"description": "Successful API operation completed",
"properties": {
"data": {
"type": "array",
"description": "root element json",
"items": {
"$ref": "#/components/schemas/SuccessDataNested"
},
"maxItems": 1
}
}
},
"SuccessDataNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for data",
"properties": {
"code": {
"type": "string",
"description": "success code",
"maxLength": 255
},
"details": {
"$ref": "#/components/schemas/DetailsNested"
},
"message": {
"type": "string",
"description": "Success message",
"maxLength": 255
},
"status": {
"type": "string",
"description": "response status",
"maxLength": 255
}
}
},
"DetailsNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for details",
"properties": {
"cadences": {
"type": "array",
"description": "Field: cadences",
"items": {
"$ref": "#/components/schemas/CadencesNested"
},
"maxItems": 2
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
}
},
"CadencesNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for cadences",
"properties": {
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
}
},
"ErrorDataNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for data",
"properties": {
"code": {
"type": "string",
"description": "Respone code",
"enum": [
"INVALID_DATA"
],
"maxLength": 255
},
"details": {
"type": "object",
"description": "details schema for error case",
"additionalProperties": true,
"properties": {
"api_name": {
"type": "string",
"description": "api_name of error details",
"maxLength": 255,
"enum": [
"ids"
]
},
"json_path": {
"type": "string",
"description": "json_path of error details",
"maxLength": 255
}
}
},
"message": {
"type": "string",
"description": "error message",
"maxLength": 255
},
"status": {
"type": "string",
"description": "status of the request",
"enum": [
"error"
],
"maxLength": 255
}
}
},
"PostcadencesResponse207": {
"type": "object",
"additionalProperties": false,
"description": "Multi status response for unenrolment",
"properties": {
"data": {
"type": "array",
"description": "Field: data",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/SuccessDataNested"
},
{
"$ref": "#/components/schemas/ErrorDataNested"
}
]
},
"maxItems": 100
}
}
},
"ErrorResponse403": {
"type": "object",
"additionalProperties": false,
"description": "No permission to access this resource",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"NO_PERMISSION"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"permissions": {
"type": "array",
"description": "Detail field: permissions",
"items": {
"type": "string",
"description": "Detail Field: permissions",
"maxLength": 255
},
"maxItems": 25
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"No permission"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response 403"
},
"ErrorResponseCore814179042": {
"type": "object",
"additionalProperties": false,
"description": "Invalid data type for field: cadences_ids",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"LIMIT_EXCEEDED"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"limit": {
"type": "integer",
"format": "int32",
"description": "Detail field: limit"
},
"limit_due_to": {
"type": "array",
"description": "Detail field: limit_due_to",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Detail Field: limit_due_to",
"properties": {
"api_name": {
"type": "string",
"description": "Nested detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Nested detail field: json_path",
"maxLength": 1000
}
},
"required": [
"api_name",
"json_path"
]
},
"maxItems": 25
}
},
"required": [
"limit",
"limit_due_to"
]
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"Limit Exceeded, You cannot give more than 5 cadence ids"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"ErrorResponseCore1137512454": {
"type": "object",
"additionalProperties": false,
"description": "Invalid data type for field: cadences_ids",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"maximum_length": {
"type": "integer",
"format": "int32",
"description": "Detail field: maximum_length"
},
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
}
},
"required": [
"api_name",
"json_path",
"maximum_length"
]
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"invalid data"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"ErrorResponseCore260315750": {
"type": "object",
"additionalProperties": false,
"description": "API not supported for client portal users",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"API_NOT_SUPPORTED"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"unsupported_login_user_type": {
"type": "string",
"description": "Detail field: unsupported_login_user_type",
"maxLength": 255
}
},
"required": [
"unsupported_login_user_type"
]
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"api not supported for client portal user"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"ErrorResponseCore1414382895": {
"type": "object",
"additionalProperties": false,
"description": "id given is not manual enrollment cadence",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"NOT_ALLOWED"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"api_name": {
"type": "string",
"description": "Detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail field: json_path",
"maxLength": 1000
}
},
"required": [
"api_name",
"json_path"
]
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"id given is not manual enrollment cadence"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"ErrorResponseCore1243473672": {
"type": "object",
"additionalProperties": false,
"description": "API not supported for selected domains",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"API_NOT_SUPPORTED"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"supported_domains": {
"type": "array",
"description": "Detail field: supported_domains",
"items": {
"type": "string",
"description": "Detail Field: supported_domains",
"maxLength": 255
},
"maxItems": 25
}
},
"required": [
"supported_domains"
]
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"api not supported"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"ErrorResponseCore1362235056": {
"type": "object",
"additionalProperties": false,
"description": "Invalid data type for field: ids",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"LIMIT_EXCEEDED"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"limit": {
"type": "integer",
"format": "int32",
"description": "Detail field: limit"
},
"limit_due_to": {
"type": "array",
"description": "Detail field: limit_due_to",
"items": {
"type": "object",
"additionalProperties": false,
"description": "Detail Field: limit_due_to",
"properties": {
"api_name": {
"type": "string",
"description": "Nested detail field: api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Nested detail field: json_path",
"maxLength": 1000
}
},
"required": [
"api_name",
"json_path"
]
},
"maxItems": 25
}
},
"required": [
"limit",
"limit_due_to"
]
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"Limit Exceeded, You cannot give more than 100 record ids"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
}
},
"securitySchemes": {
"iam-oauth2-schema": {
"type": "oauth2",
"description": "OAuth2 authentication for API access",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
"tokenUrl": "https://accounts.zoho.com/oauth/v2/token",
"refreshUrl": "https://accounts.zoho.com/oauth/v2/token",
"scopes": {
"ZohoCRM.modules.Leads.CREATE": "Create access to Leads",
"ZohoCRM.modules.Contacts.CREATE": "Create access to Contacts",
"ZohoCRM.modules.Accounts.CREATE": "Create access to Accounts",
"ZohoCRM.modules.Deals.CREATE": "Create access to Deals",
"ZohoCRM.modules.Tasks.CREATE": "Create access to Tasks",
"ZohoCRM.modules.Events.CREATE": "Create access to Events",
"ZohoCRM.modules.Calls.CREATE": "Create access to Calls",
"ZohoCRM.modules.Products.CREATE": "Create access to Products",
"ZohoCRM.modules.Vendors.CREATE": "Create access to Vendors",
"ZohoCRM.modules.Campaigns.CREATE": "Create access to Campaigns",
"ZohoCRM.modules.Cases.CREATE": "Create access to Cases",
"ZohoCRM.modules.Solutions.CREATE": "Create access to Solutions",
"ZohoCRM.modules.Quotes.CREATE": "Create access to Quotes",
"ZohoCRM.modules.Invoices.CREATE": "Create access to Invoices",
"ZohoCRM.modules.Forecasts.CREATE": "Create access to Forecasts",
"ZohoCRM.modules.Activities.CREATE": "Create access to Activities",
"ZohoCRM.modules.Notes.CREATE": "Create access to Notes",
"ZohoCRM.modules.Attachments.CREATE": "Create access to Attachments",
"ZohoCRM.modules.custom.CREATE": "Create access to custom modules"
}
}
}
}
}
}
}