Manage Workflow task (Create, edit,delete and view). Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 6 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Automation Task",
"description": "Manage Workflow task (Create, edit,delete and view).",
"version": "8"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"description": "API Server URL TLD",
"default": "com",
"enum": [
"com",
"eu",
"in",
"cn",
"au",
"ca",
"jp"
]
},
"version": {
"description": "API Version",
"default": "v8"
}
}
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.READ",
"ZohoCRM.settings.automation_actions.CREATE",
"ZohoCRM.settings.automation_actions.UPDATE",
"ZohoCRM.settings.automation_actions.DELETE"
]
}
],
"paths": {
"/settings/automation/tasks": {
"get": {
"summary": "GET /settings/automation/tasks",
"description": "To retrieve the list of automation tasks configured in your Zoho CRM organization.",
"operationId": "getTasks",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryFeatureType"
},
{
"$ref": "#/components/parameters/ParamQueryModule"
},
{
"$ref": "#/components/parameters/ParamQueryPerPage"
},
{
"$ref": "#/components/parameters/ParamQueryPage"
}
],
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTasksSuccessResponse"
}
}
}
},
"400": {
"description": "Invalid module param",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidModuleErrorResponse"
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.READ"
]
}
]
},
"post": {
"summary": "POST /settings/automation/tasks",
"description": "To create an automation task in your Zoho CRM organization.",
"operationId": "postTasks",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema2"
}
}
}
},
"responses": {
"201": {
"description": "Success Case",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema5"
}
}
}
},
"400": {
"description": "Auto-generated from ApiDefinition for INVALID_DATA",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with tasks",
"properties": {
"tasks": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore10"
},
{
"$ref": "#/components/schemas/ErrorResponseCore4"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1"
},
{
"$ref": "#/components/schemas/ErrorResponseCore7"
},
{
"$ref": "#/components/schemas/ErrorResponseCore2"
},
{
"$ref": "#/components/schemas/ErrorResponseCore19"
},
{
"$ref": "#/components/schemas/ErrorResponseCore16"
},
{
"$ref": "#/components/schemas/ErrorResponseCore8"
},
{
"$ref": "#/components/schemas/ErrorResponseCore13"
},
{
"$ref": "#/components/schemas/ErrorResponseCore5"
},
{
"$ref": "#/components/schemas/ErrorResponseCore17"
},
{
"$ref": "#/components/schemas/ErrorResponseCore14"
},
{
"$ref": "#/components/schemas/ErrorResponseCore12"
},
{
"$ref": "#/components/schemas/ErrorResponseCore6"
}
]
},
"maxItems": 25
}
},
"required": [
"tasks"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with tasks",
"properties": {
"tasks": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore14"
},
{
"$ref": "#/components/schemas/ErrorResponseCore12"
},
{
"$ref": "#/components/schemas/ErrorResponseCore6"
}
]
}
},
"required": [
"tasks"
]
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.CREATE"
]
}
]
},
"delete": {
"summary": "DELETE /settings/automation/tasks",
"description": "To delete automation tasks configured in your Zoho CRM account.",
"operationId": "deleteTasks",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryIds"
}
],
"responses": {
"200": {
"description": "Success Case",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema8"
}
}
}
},
"207": {
"description": "When one task got deleted successfully while other tasks failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema1"
}
}
}
},
"400": {
"description": "Missing required parameter: ids",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore15"
},
{
"$ref": "#/components/schemas/ErrorResponseCore3"
},
{
"$ref": "#/components/schemas/ErrorResponseCore10"
},
{
"$ref": "#/components/schemas/ErrorResponseCore"
}
]
}
}
}
},
"403": {
"description": "When the user doesn't have permission.\n(manageworkflow)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseCore11"
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.DELETE"
]
}
]
}
},
"/settings/automation/tasks/{id}": {
"get": {
"summary": "GET /settings/automation/tasks/{id}",
"description": "To retrieve automation tasks configured in your Zoho CRM organization",
"operationId": "getTaskById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the task to retrieve",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
},
{
"$ref": "#/components/parameters/ParamQueryIncludeInnerDetails"
}
],
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema7"
}
}
}
},
"400": {
"description": "Invalid Task Id ",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseCore3"
}
}
}
},
"403": {
"description": "No permssion Crm_Implied_manage_workflow",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseCore11"
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.READ"
]
}
]
},
"put": {
"summary": "PUT /settings/automation/tasks/123445566",
"description": "To update an automation task in your Zoho CRM organization.",
"operationId": "putTasksById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the task to retrieve",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema"
}
}
}
},
"responses": {
"200": {
"description": "Success response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema6"
}
}
}
},
"400": {
"description": "Auto-generated from ApiDefinition for INVALID_DATA",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with tasks",
"properties": {
"tasks": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore7"
},
{
"$ref": "#/components/schemas/ErrorResponseCore2"
},
{
"$ref": "#/components/schemas/ErrorResponseCore4"
},
{
"$ref": "#/components/schemas/ErrorResponseCore16"
},
{
"$ref": "#/components/schemas/ErrorResponseCore8"
},
{
"$ref": "#/components/schemas/ErrorResponseCore13"
},
{
"$ref": "#/components/schemas/ErrorResponseCore5"
},
{
"$ref": "#/components/schemas/ErrorResponseCore17"
},
{
"$ref": "#/components/schemas/ErrorResponseCore18"
},
{
"$ref": "#/components/schemas/ErrorResponseCore14"
},
{
"$ref": "#/components/schemas/ErrorResponseCore12"
},
{
"$ref": "#/components/schemas/ErrorResponseCore6"
},
{
"$ref": "#/components/schemas/ErrorResponseCore9"
}
]
},
"maxItems": 25
}
},
"required": [
"tasks"
]
},
{
"$ref": "#/components/schemas/ErrorResponseCore3"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with tasks",
"properties": {
"tasks": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore14"
},
{
"$ref": "#/components/schemas/ErrorResponseCore12"
},
{
"$ref": "#/components/schemas/ErrorResponseCore6"
}
]
}
},
"required": [
"tasks"
]
}
]
}
}
}
},
"401": {
"description": "Locked task cannot be edited",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with tasks",
"properties": {
"tasks": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore7"
},
{
"$ref": "#/components/schemas/ErrorResponseCore2"
},
{
"$ref": "#/components/schemas/ErrorResponseCore16"
},
{
"$ref": "#/components/schemas/ErrorResponseCore8"
},
{
"$ref": "#/components/schemas/ErrorResponseCore13"
},
{
"$ref": "#/components/schemas/ErrorResponseCore5"
},
{
"$ref": "#/components/schemas/ErrorResponseCore17"
},
{
"$ref": "#/components/schemas/ErrorResponseCore18"
},
{
"$ref": "#/components/schemas/ErrorResponseCore14"
},
{
"$ref": "#/components/schemas/ErrorResponseCore12"
},
{
"$ref": "#/components/schemas/ErrorResponseCore6"
},
{
"$ref": "#/components/schemas/ErrorResponseCore9"
}
]
},
"maxItems": 25
}
},
"required": [
"tasks"
]
}
}
}
},
"403": {
"description": "When the user doesn't have permission.\n(manageworkflow)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseCore11"
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.UPDATE"
]
}
]
},
"delete": {
"summary": "DELETE /settings/automation/tasks/{id}",
"description": "To delete automation tasks configured in your Zoho CRM account.",
"operationId": "deleteTaskById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the task to retrieve",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"responses": {
"200": {
"description": "he Task is Deleted successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSchema3"
}
}
}
},
"400": {
"description": "Invalid Task Id ",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore10"
},
{
"$ref": "#/components/schemas/ErrorResponseCore3"
}
]
}
}
}
},
"403": {
"description": "Crm_Implied_manage_workflow",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponseCore11"
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.automation_actions.DELETE"
]
}
]
}
}
},
"components": {
"schemas": {
"GeneratedSchema1": {
"type": "object",
"additionalProperties": false,
"description": "When one task got deleted successfully while other tasks failed.",
"properties": {
"tasks": {
"type": "array",
"description": "Field: tasks",
"items": {
"$ref": "#/components/schemas/GeneratedSchema9"
},
"maxItems": 2
}
},
"title": "Generated Schema"
},
"ModifierDetails": {
"type": "object",
"additionalProperties": false,
"description": "Provides details about the individual who modified an entity, including their name and ID.",
"properties": {
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
},
"title": "Modifier Details"
},
"PaginationInfo": {
"type": "object",
"additionalProperties": false,
"description": "Details about pagination for resource listings, such as count, page number, and if more records are available.",
"properties": {
"per_page": {
"type": "integer",
"format": "int32",
"description": "Field: per_page"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Field: count"
},
"page": {
"type": "integer",
"format": "int32",
"description": "Field: page"
},
"more_records": {
"type": "boolean",
"description": "Field: more_records"
}
},
"title": "Pagination Information"
},
"GeneratedSchema3": {
"type": "object",
"additionalProperties": false,
"description": "he Task is Deleted successfully",
"properties": {
"tasks": {
"type": "array",
"description": "Field: tasks",
"items": {
"$ref": "#/components/schemas/GeneratedSchema9"
},
"maxItems": 1
}
},
"title": "Generated Schema"
},
"GeneratedSchema2": {
"type": "object",
"additionalProperties": false,
"description": "Request body schema",
"properties": {
"tasks": {
"type": "array",
"description": "Root Element (Required)",
"items": {
"$ref": "#/components/schemas/TaskDetails"
},
"maxItems": 1
}
},
"required": [
"tasks"
],
"title": "Generated Schema"
},
"GeneratedSchema5": {
"type": "object",
"additionalProperties": false,
"description": "Success Case",
"properties": {
"tasks": {
"type": "array",
"description": "Field: tasks",
"items": {
"$ref": "#/components/schemas/GeneratedSchema9"
},
"maxItems": 1
}
},
"title": "Generated Schema"
},
"GeneratedSchema4": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for details",
"properties": {
"resource_path_index": {
"type": "string",
"description": "Field: resource_path_index",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
},
"title": "Generated Schema"
},
"GeneratedSchema7": {
"type": "object",
"additionalProperties": false,
"description": "Success response",
"properties": {
"tasks": {
"type": "array",
"description": "Field: tasks",
"items": {
"$ref": "#/components/schemas/TaskDetails"
},
"maxItems": 1
}
},
"title": "Generated Schema"
},
"ErrorResponseCore19": {
"type": "object",
"additionalProperties": false,
"description": "Mandatory Fields is not given",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"MANDATORY_NOT_FOUND"
]
},
"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
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"mandatory field is not given"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"GeneratedSchema": {
"type": "object",
"additionalProperties": false,
"description": "Request body schema",
"properties": {
"tasks": {
"type": "array",
"description": "Root Element (Required)",
"items": {
"$ref": "#/components/schemas/TaskDetails"
},
"maxItems": 1
}
},
"required": [
"tasks"
],
"title": "Generated Schema"
},
"GeneratedSchema6": {
"type": "object",
"additionalProperties": false,
"description": "Success response",
"properties": {
"tasks": {
"type": "array",
"description": "Field: tasks",
"items": {
"$ref": "#/components/schemas/GeneratedSchema9"
},
"maxItems": 1
}
},
"title": "Generated Schema"
},
"GeneratedSchema9": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for tasks",
"properties": {
"code": {
"type": "string",
"description": "Field: code",
"maxLength": 255
},
"details": {
"$ref": "#/components/schemas/GeneratedSchema4"
},
"message": {
"type": "string",
"description": "Field: message",
"maxLength": 255
},
"status": {
"type": "string",
"description": "Field: status",
"maxLength": 255
}
},
"title": "Generated Schema"
},
"GeneratedSchema8": {
"type": "object",
"additionalProperties": false,
"description": "Success Case",
"properties": {
"tasks": {
"type": "array",
"description": "Field: tasks",
"items": {
"$ref": "#/components/schemas/GeneratedSchema9"
},
"maxItems": 3
}
},
"title": "Generated Schema"
},
"RelatedModuleDetails": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"description": "Describes a related module, with details about its labels, API name, and ID.",
"properties": {
"singular_label": {
"type": "string",
"description": "Field: singular_label",
"maxLength": 255
},
"plural_label": {
"type": "string",
"description": "Field: plural_label",
"maxLength": 255
},
"api_name": {
"type": "string",
"description": "Field: api_name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
},
"module_name": {
"type": "string",
"description": "Field: module_name",
"maxLength": 255
}
},
"title": "Related Module Details"
},
"ErrorResponseCore": {
"type": "object",
"additionalProperties": false,
"description": "Missing required parameter: ids",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"REQUIRED_PARAM_MISSING"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"param_name": {
"type": "string",
"description": "Detail field: param_name",
"maxLength": 255
}
}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"One of the expected parameter is missing"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"ModuleDetails": {
"type": "object",
"additionalProperties": false,
"description": "Contains information about a module, including labels and API names.",
"properties": {
"singular_label": {
"type": "string",
"description": "Field: singular_label",
"maxLength": 255
},
"moduleName": {
"type": "string",
"description": "Field: moduleName",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
},
"plural_label": {
"type": "string",
"description": "Field: plural_label",
"maxLength": 255
},
"api_name": {
"type": "string",
"description": "Field: api_name",
"maxLength": 255
}
},
"required": [
"api_name"
],
"title": "Module Details"
},
"FieldMappings": {
"type": "object",
"additionalProperties": false,
"description": "Defines mappings of fields, including display values, types, and associated fields.",
"properties": {
"display_value": {
"type": "string",
"description": "Field: display_value",
"maxLength": 255
},
"field": {
"$ref": "#/c
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-workflow-tasks-openapi.json