This file contains tags CRUD apis. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 5 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Tags CRUD API",
"description": "This file contains tags CRUD apis",
"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": {
"/settings/tags": {
"get": {
"summary": "this endpoint is used to get tags from a module",
"description": "to get tags from a module",
"operationId": "getTags",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryModule"
},
{
"$ref": "#/components/parameters/ParamQueryInclude"
}
],
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GettagsResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "When the request is invalid",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1241530911"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1335454202"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1273605641"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"description": "When the user does not have sufficient permissions to access the resource",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1161913208"
}
]
}
}
}
},
"404": {
"description": "Not Found - The server can not find the requested resource.",
"content": {
"application/json": {
"schema": {
"description": "When the requested resource is not found",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore767063671"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.tags.READ"
]
}
]
},
"put": {
"summary": "PUT /settings/tags",
"description": "Put API with Tag id in request body",
"operationId": "putTags",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryModule"
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PuttagsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PuttagsResponse200"
}
}
}
},
"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/ErrorResponseCore1335454202"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1273605641"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with tags",
"properties": {
"tags": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore619698125"
},
{
"$ref": "#/components/schemas/ErrorResponseCoreInvalidData"
},
{
"$ref": "#/components/schemas/ErrorResponseCore491436158"
},
{
"$ref": "#/components/schemas/ErrorResponseCore501721585"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1093417477"
},
{
"$ref": "#/components/schemas/ErrorResponseCore239878082"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1381982232"
}
]
},
"maxItems": 25
}
},
"required": [
"tags"
]
},
{
"$ref": "#/components/schemas/ErrorResponseCore1241530911"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
},
{
"$ref": "#/components/schemas/ErrorResponseCore62955412"
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"description": "When the user does not have sufficient permissions",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1161913208"
}
]
}
}
}
},
"404": {
"description": "Not Found - The server can not find the requested resource.",
"content": {
"application/json": {
"schema": {
"description": "When the requested resource is not found",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore767063671"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.tags.UPDATE"
]
}
]
},
"post": {
"summary": "POST /settings/tags",
"description": "This endpoint is used to create tags",
"operationId": "postTags",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryModule"
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PosttagsRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created - Resource created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PosttagsResponse201"
}
}
}
},
"207": {
"description": "Multi-Status — Response contains mixed status results",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"description": "Wrapped response containing tags",
"properties": {
"tags": {
"type": "array",
"allOf": [
{
"contains": {
"$ref": "#/components/schemas/Post207multistatusResponse207"
},
"description": "success response in tags",
"minContains": 1
},
{
"contains": {
"$ref": "#/components/schemas/ErrorResponseCore501721585"
},
"description": "error response in tags",
"minContains": 1
}
],
"description": "Array of success or failure tags items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Post207multistatusResponse207"
},
{
"$ref": "#/components/schemas/ErrorResponseCore501721585"
}
]
},
"maxItems": 200,
"minItems": 2
}
},
"required": [
"tags"
]
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "When the request is invalid",
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with tags",
"properties": {
"tags": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore393894623"
},
{
"$ref": "#/components/schemas/ErrorResponseCore619698125"
},
{
"$ref": "#/components/schemas/ErrorResponseCoreInvalidData"
},
{
"$ref": "#/components/schemas/ErrorResponseCore491436158"
},
{
"$ref": "#/components/schemas/ErrorResponseCore501721585"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1093417477"
},
{
"$ref": "#/components/schemas/ErrorResponseCore239878082"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1381982232"
}
]
},
"maxItems": 25
}
},
"required": [
"tags"
]
},
{
"$ref": "#/components/schemas/ErrorResponseCore1335454202"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1273605641"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1241530911"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"description": "When the user does not have sufficient permissions",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1161913208"
}
]
}
}
}
},
"404": {
"description": "Not Found - The server can not find the requested resource.",
"content": {
"application/json": {
"schema": {
"description": "When the requested URL pattern is invalid",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore767063671"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.tags.CREATE"
]
}
]
}
},
"/settings/tags/{id}": {
"put": {
"summary": "PUT /settings/tags/{id}",
"description": "This endpoint is used to update the tag details",
"operationId": "putTagsWithId",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryId"
},
{
"$ref": "#/components/parameters/ParamPathId"
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PuttagsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PuttagsResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "When invalid request is made",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore62955412"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1335454202"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1273605641"
},
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with tags",
"properties": {
"tags": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore619698125"
},
{
"$ref": "#/components/schemas/ErrorResponseCoreInvalidData"
},
{
"$ref": "#/components/schemas/ErrorResponseCore491436158"
},
{
"$ref": "#/components/schemas/ErrorResponseCore501721585"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1093417477"
},
{
"$ref": "#/components/schemas/ErrorResponseCore239878082"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1381982232"
}
]
},
"maxItems": 25
}
},
"required": [
"tags"
]
},
{
"$ref": "#/components/schemas/ErrorResponseCore1241530911"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"description": "When Tag read permission is not available.",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1161913208"
}
]
}
}
}
},
"404": {
"description": "Not Found - The server can not find the requested resource.",
"content": {
"application/json": {
"schema": {
"description": "When a invalid URL Pattern is given",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore767063671"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.tags.UPDATE"
]
}
]
},
"delete": {
"summary": "DELETE /settings/tags/{id}",
"description": "This endpoint is used to delete Tags",
"operationId": "deleteTags",
"parameters": [
{
"$ref": "#/components/parameters/ParamPathId"
}
],
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletetagsResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"description": "When invalid request is made",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
},
{
"$ref": "#/components/schemas/ErrorResponseCore987684789"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1335454202"
}
]
}
}
}
},
"403": {
"description": "Forbidden - The client does not have access rights to the content.",
"content": {
"application/json": {
"schema": {
"description": "When Tag read permission is not available.",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1161913208"
}
]
}
}
}
},
"404": {
"description": "Not Found - The server can not find the requested resource.",
"content": {
"application/json": {
"schema": {
"description": "When a invalid URL Pattern is given",
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore767063671"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.tags.DELETE"
]
}
]
}
}
},
"components": {
"schemas": {
"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
}
}
},
"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"
},
"GETCreatedByNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for created_by",
"properties": {
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
},
"required": [
"id",
"name"
]
},
"ErrorResponseCore1161913208": {
"type": "object",
"additionalProperties": false,
"description": "When Tag read permission is not available.",
"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"
},
"ErrorResponseCore767063671": {
"type": "object",
"additionalProperties": false,
"description": "When a invalid URL Pattern is given",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_URL_PATTERN"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"Please check if the URL trying to access is a correct one"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"ErrorResponseCore1241530911": {
"type": "object",
"additionalProperties": false,
"description": "Missing required parameter: module",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"REQUIRED_PARAM_MISSING"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"param": {
"type": "string",
"description": "Detail field: param",
"maxLength": 255
}
},
"required": [
"param"
]
},
"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"
},
"ErrorResponseCore393894623": {
"type": "object",
"additionalProperties": false,
"description": "When Tags module limit exceeded",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"LICENSE_LIMIT_EXCEEDED"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {}
},
"message": {
"type": "string",
"description": "Error message",
"enum": [
"tags edition limit exceeded"
]
},
"status": {
"type": "string",
"description": "Error status",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"title": "Error Response Core"
},
"DetailsNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for details",
"properties": {
"created_time": {
"type": "string",
"format": "date-time",
"description": "Field: created_time",
"maxLength": 255
},
"modified_time": {
"type": "string",
"format": "date-time",
"description": "Field: modified_time",
"maxLength": 255
},
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"modified_by": {
"$ref": "#/components/schemas/ModifiedByNested"
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
},
"created_by": {
"$ref": "#/components/schemas/CreatedByNested"
},
"color_code": {
"type": [
"string",
"null"
],
"description": "Field: color_code",
"maxLength": 255
}
}
},
"CreatedByNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for created_by",
"properties": {
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
}
},
"PosttagsResponse201": {
"type": "object",
"additionalProperties": false,
"description": "Success response for Tags Creation",
"properties": {
"tags": {
"type": "array",
"description": "Field: tags",
"items": {
"$ref": "#/components/schemas/TagsNested1"
},
"maxItems": 20
}
}
},
"ErrorResponseCore501721585": {
"type": "object",
"additionalProperties": false,
"description": "Auto-generated from 207 Multi-Status error item",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"DUPLICATE_DATA"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details with validation information",
"properties": {
"api_name": {
"type": "string",
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-tags-openapi.json