Zoho CRM Mass Delete Tags

API for mass deletion of tags in Zoho CRM. This endpoint allows administrators to delete multiple tags across modules in bulk.

OpenAPI Specification

zoho-crm-mass-delete-tags-openapi.json Raw ↑
{
  "openapi": "3.1.0",
  "info": {
    "title": "Mass Delete Tags",
    "description": "API for mass deletion of tags in Zoho CRM. This endpoint allows administrators to delete multiple tags across modules in bulk.",
    "version": "8"
  },
  "servers": [
    {
      "url": "https://zohoapis.{dc}/crm/{version}",
      "description": "API Server URL",
      "variables": {
        "dc": {
          "enum": [
            "com",
            "eu",
            "in",
            "cn",
            "au"
          ],
          "default": "com",
          "description": "API Server URL TLD"
        },
        "version": {
          "default": "v8",
          "description": "API Version"
        }
      }
    }
  ],
  "security": [
    {
      "iam-oauth2-schema": [
        "ZohoCRM.settings.tags.READ",
        "ZohoCRM.settings.tags.DELETE"
      ]
    }
  ],
  "paths": {
    "/settings/tags/actions/mass_delete": {
      "post": {
        "summary": "Schedule mass delete tags job",
        "operationId": "createMassDeleteTags",
        "description": "Schedules a job to delete multiple tags across modules in Zoho CRM.",
        "requestBody": {
          "description": "Request body containing list of modules and tags to be deleted",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "description": "Schema for scheduling mass delete tags job",
                "additionalProperties": false,
                "properties": {
                  "mass_delete": {
                    "type": "array",
                    "description": "Array of modules and corresponding tags to delete",
                    "maxItems": 100,
                    "items": {
                      "type": "object",
                      "description": "Module and tags information",
                      "additionalProperties": false,
                      "properties": {
                        "module": {
                          "type": "object",
                          "description": "Module in which tags need to be deleted",
                          "additionalProperties": false,
                          "properties": {
                            "api_name": {
                              "type": "string",
                              "maxLength": 50,
                              "description": "API for mass deletion of tags in Zoho CRM. This endpoint allows administrators to delete multiple tags across modules in bulk."
                            },
                            "id": {
                              "type": "string",
                              "maxLength": 50,
                              "description": "Unique identifier of the mass delete job"
                            }
                          },
                          "required": [
                            "api_name",
                            "id"
                          ]
                        },
                        "tags": {
                          "type": "array",
                          "description": "List of tags to be deleted in the module",
                          "maxItems": 100,
                          "items": {
                            "type": "object",
                            "description": "Tag information",
                            "additionalProperties": false,
                            "properties": {
                              "id": {
                                "type": "string",
                                "maxLength": 50,
                                "description": "API for mass deletion of tags in Zoho CRM. This endpoint allows administrators to delete multiple tags across modules in bulk."
                              },
                              "name": {
                                "type": "string",
                                "maxLength": 50,
                                "description": "tag name"
                              }
                            },
                            "required": [
                              "id"
                            ]
                          }
                        }
                      },
                      "required": [
                        "module",
                        "tags"
                      ]
                    }
                  }
                },
                "required": [
                  "mass_delete"
                ]
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "The mass delete job has been scheduled successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "description": "Response schema for mass delete job creation",
                  "additionalProperties": false,
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Indicates the success status of the request",
                      "maxLength": 20
                    },
                    "code": {
                      "type": "string",
                      "description": "status code",
                      "maxLength": 10
                    },
                    "details": {
                      "type": "object",
                      "description": "Details of the scheduled job",
                      "additionalProperties": false,
                      "properties": {
                        "job_id": {
                          "type": "string",
                          "description": "Unique identifier of the scheduled mass delete job",
                          "maxLength": 50
                        }
                      },
                      "required": [
                        "job_id"
                      ]
                    }
                  },
                  "required": [
                    "status",
                    "code",
                    "details"
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "iam-oauth2-schema": [
              "ZohoCRM.settings.tags.DELETE"
            ]
          }
        ]
      },
      "get": {
        "summary": "Get status of mass delete job",
        "operationId": "getStatus",
        "description": "Retrieve the status of a scheduled mass delete job using its job_id",
        "responses": {
          "200": {
            "description": "Returns the status and summary of the requested mass delete job",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "description": "Schema for mass delete job status response",
                  "additionalProperties": false,
                  "properties": {
                    "mass_delete": {
                      "type": "array",
                      "description": "List of mass delete jobs with their current status",
                      "maxItems": 100,
                      "items": {
                        "type": "object",
                        "description": "Single mass delete job information",
                        "additionalProperties": false,
                        "properties": {
                          "job_id": {
                            "type": "string",
                            "maxLength": 50,
                            "description": "Unique identifier of the mass delete job"
                          },
                          "status": {
                            "type": "string",
                            "maxLength": 20,
                            "description": "Returns the status and summary of the requested mass delete job"
                          },
                          "created_time": {
                            "type": "string",
                            "format": "date-time",
                            "description": "Response schema for mass delete job creation"
                          }
                        },
                        "required": [
                          "job_id",
                          "status"
                        ]
                      }
                    }
                  },
                  "required": [
                    "mass_delete"
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "iam-oauth2-schema": [
              "ZohoCRM.settings.tags.READ"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "iam-oauth2-schema": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://accounts.zoho.com/oauth/v2/token",
            "scopes": {
              "ZohoCRM.settings.tags.READ": "Read access to tags",
              "ZohoCRM.settings.tags.DELETE": "Delete access to tags"
            }
          }
        }
      }
    }
  }
}