This file contains tag actions endpoints. 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": "Tag Actions API",
"description": "This file contains tag actions endpoints.",
"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"
}
}
}
],
"paths": {
"/{module}/actions/add_tags": {
"post": {
"summary": "POST /{module}/actions/add_tags",
"description": "This endpoint is used to associate tags to records",
"operationId": "postAddTags",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryModule"
},
{
"$ref": "#/components/parameters/ParamPathModule"
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostaddtagsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostaddtagsResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "Error response for status 400",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore2107518198"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1799630392"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1335454202"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1273605641"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
},
{
"$ref": "#/components/schemas/ErrorResponseCore94581445"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with tags",
"properties": {
"tags": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore239878082"
},
{
"$ref": "#/components/schemas/ErrorResponseCore356490233"
}
]
},
"maxItems": 25
}
},
"required": [
"tags"
]
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"description": "Error response for status 403",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1161913208"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.tags.all"
]
}
]
}
},
"/{module}/actions/remove_tags": {
"post": {
"summary": "POST /{module}/actions/remove_tags",
"description": "This endpoint is used to remove tags from records",
"operationId": "postRemoveTags",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryModule1"
},
{
"$ref": "#/components/parameters/ParamPathModule"
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostremovetagsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostremovetagsResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "Error response for status 400",
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with data",
"properties": {
"data": {
"type": "array",
"description": "Array of error objects",
"items": {
"$ref": "#/components/schemas/ErrorResponseCore2107518198"
},
"maxItems": 25
},
"locked_count": {
"maxLength": 10,
"type": "string",
"description": "Number of locked records"
}
},
"required": [
"data"
]
},
{
"$ref": "#/components/schemas/ErrorResponseCore1799630392"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1335454202"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1273605641"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with tags",
"properties": {
"tags": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore239878082"
},
{
"$ref": "#/components/schemas/ErrorResponseCore356490233"
}
]
},
"maxItems": 25
}
},
"required": [
"tags"
]
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"description": "Error response for status 403",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1161913208"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.tags.all"
]
}
]
}
},
"/{module}/{id}/actions/add_tags": {
"post": {
"summary": "POST /{module}/{id}/actions/add_tags",
"description": "This endpoint is used to add tags to record",
"operationId": "postAddTagsWithId",
"parameters": [
{
"$ref": "#/components/parameters/ParamPathModule"
},
{
"$ref": "#/components/parameters/ParamPathId"
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostaddtagsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostaddtagsResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "Error response for status 400",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore2107518198"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1799630392"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1335454202"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1273605641"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
},
{
"$ref": "#/components/schemas/TagErrorItemResponse"
},
{
"$ref": "#/components/schemas/ErrorResponseCore833637355"
},
{
"$ref": "#/components/schemas/MappingMismatchErrorResponse"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with tags",
"properties": {
"tags": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore239878082"
},
{
"$ref": "#/components/schemas/ErrorResponseCore356490233"
}
]
},
"maxItems": 25
}
},
"required": [
"tags"
]
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"description": "Error response for status 403",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1161913208"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.tags.all"
]
}
]
}
},
"/{module}/{id}/actions/remove_tags": {
"post": {
"summary": "POST /{module}/{id}/actions/remove_tags",
"description": "This endpoint is used to dissociate tags from records",
"operationId": "postRemoveTagsWithId",
"parameters": [
{
"$ref": "#/components/parameters/ParamPathModule"
},
{
"$ref": "#/components/parameters/ParamPathId"
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostremovetagsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostremovetagsResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "Error response for status 400",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore2107518198"
},
{
"$ref": "#/components/schemas/ErrorResponseCore833637355"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1335454202"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1273605641"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1799630392"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with tags",
"properties": {
"tags": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore239878082"
},
{
"$ref": "#/components/schemas/ErrorResponseCore356490233"
}
]
},
"maxItems": 25
}
},
"required": [
"tags"
]
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"description": "Error response for status 403",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1161913208"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.tags.all"
]
}
]
}
},
"/settings/tags/{id}/actions/records_count": {
"get": {
"summary": "GET /settings/tags/{id}/actions/records_count",
"description": "This endpoint is used to get the number of records associated to the tag.",
"operationId": "getRecordsCount",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryId"
},
{
"$ref": "#/components/parameters/ParamQueryModule"
},
{
"$ref": "#/components/parameters/ParamPathId"
}
],
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetrecordscountResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "Error response for status 400",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore94581445"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1335454202"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1273605641"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
},
{
"$ref": "#/components/schemas/ErrorResponseTagIdNotFound"
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"description": "When permission doesn't exists",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1161913208"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.tags.all"
]
}
]
}
},
"/settings/tags/{id}/actions/merge": {
"post": {
"summary": "POST /settings/tags/{id}/actions/merge",
"description": "This endpoint is used to merge two tags",
"operationId": "postMerge",
"parameters": [
{
"$ref": "#/components/parameters/ParamPathId"
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.tags.all"
]
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostmergeRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostmergeResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "Error response for status 400",
"anyOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore833637355"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
},
{
"type": "object",
"description": "Wrapped error response with tag-level errors",
"additionalProperties": false,
"properties": {
"tags": {
"type": "array",
"description": "Array of tag error objects",
"items": {
"$ref": "#/components/schemas/TagErrorItemResponse"
},
"maxItems": 25
}
},
"required": [
"tags"
]
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Wrapped error response with tag-level errors",
"additionalProperties": false,
"properties": {
"tags": {
"type": "array",
"description": "Array of tag error objects",
"items": {
"$ref": "#/components/schemas/ErrorResponseCore1161913208"
},
"maxItems": 25
}
},
"required": [
"tags"
]
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"GETRulesNested1": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for rules",
"properties": {
"subtype_name": {
"type": "string",
"description": "Field: subtype_name",
"maxLength": 255
},
"subtype": {
"type": "string",
"description": "Field: subtype",
"maxLength": 255
},
"module": {
"type": "string",
"description": "Field: module",
"maxLength": 255
},
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"execution_type": {
"type": "string",
"description": "Field: execution_type",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
},
"source": {
"type": "integer",
"format": "int32",
"description": "Field: source"
},
"subtype_id": {
"type": "string",
"description": "Field: subtype_id",
"maxLength": 255
}
},
"required": [
"execution_type",
"id",
"module",
"name",
"source",
"subtype",
"subtype_id",
"subtype_name"
]
},
"ErrorResponseCore239878082": {
"type": "object",
"additionalProperties": false,
"description": "Auto-generated from ApiDefinition for INVALID_DATA",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"expected_data_type": {
"type": "string",
"description": "Detail field: expected_data_type",
"maxLength": 255
},
"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",
"expected_data_type",
"json_path"
]
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"Invalid data type"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"ErrorResponseCore1161913208": {
"type": "object",
"additionalProperties": false,
"description": "When permission doesn't exists",
"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
}
},
"required": [
"permissions"
]
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"permission denied"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"GETRulesNested2": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for rules",
"properties": {
"subtype": {
"type": "string",
"description": "Field: subtype",
"maxLength": 255
},
"module": {
"type": "string",
"description": "Field: module",
"maxLength": 255
},
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"execution_type": {
"type": "string",
"description": "Field: execution_type",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
},
"source": {
"type": "integer",
"format": "int32",
"description": "Field: source"
},
"subtype_id": {
"type": "string",
"description": "Field: subtype_id",
"maxLength": 255
}
},
"required": [
"execution_type",
"id",
"module",
"name",
"source",
"subtype",
"subtype_id"
]
},
"PostmergeResponse200": {
"type": "object",
"additionalProperties": false,
"description": "success response when tags merged successfully",
"properties": {
"tags": {
"type": "array",
"description": "Field: tags",
"items": {
"$ref": "#/components/schemas/TagsNested2"
},
"maxItems": 1
}
}
},
"GETRemovetagsNested1": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for RemoveTags",
"properties": {
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"rules": {
"type": "array",
"description": "Field: rules",
"items": {
"$ref": "#/components/schemas/GETRulesNested1"
},
"maxItems": 1
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
},
"required": [
"id",
"name",
"rules"
]
},
"GETRemovetagsNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for RemoveTags",
"properties": {
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"rules": {
"type": "array",
"description": "Field: rules",
"items": {
"$ref": "#/components/schemas/GETRulesNested"
},
"maxItems": 1
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
},
"required": [
"id",
"name",
"rules"
]
},
"PostmergeRequest": {
"type": "object",
"additionalProperties": false,
"description": "Request body schema",
"properties": {
"tags": {
"type": "array",
"description": "root key (Required)",
"items": {
"$ref": "#/components/schemas/TagsNested"
},
"maxItems": 1
}
},
"required": [
"tags"
]
},
"GETOrchestrationNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for Orchestration",
"properties": {
"3060320000000666022": {
"$ref": "#/components/schemas/GET3060320000000666022Nested"
}
},
"required": [
"3060320000000666022"
]
},
"GETCustomViewNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for custom_view",
"properties": {
"cvnames": {
"items": {},
"type": "array",
"description": "Field: cvnames",
"maxItems": 0
},
"inaccessible_custom_view_present": {
"type": "boolean",
"description": "Field: inaccessible_custom_view_present"
},
"cvmodules": {
"items": {},
"type": "array",
"description": "Field: cvmodules",
"maxItems": 0
},
"cvids": {
"items": {},
"type
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-tags-actions-openapi.json