Mass Delete Tags Status

Purpose

To get the status of a previously scheduled mass tags deletion job using the Mass Delete Tags API.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/settings/tags/actions/mass_delete

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope = ZohoCRM.settings.ALL (or)
scope = ZohoCRM.settings.tags.{operation_type}

Possible operation types

ALL - Full data access 
READ - Read tag data

Parameter

  • job_idstring, mandatory

    Represents the unique identifier for the mass delete job you scheduled previously using the Mass Delete Tags API.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v7/settings/tags/actions/mass_delete?job_id=2276164000001035002"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxd"

Response JSON Keys

  • job_idinteger

    Represents the unique identifier for the mass delete job scheduled previously.

  • total_countinteger

    Represents the number of tags that were intended to be deleted in the job.

  • failed_countinteger

    Represents the number of the tags failed to be deleted during the job.

  • deleted_countinteger

    Represents the number of tags deleted successfully during the job.

  • statusstring

    Represents the status of the mass delete job. Example : "status": "COMPLETED". 

    Possible values :  COMPLETED, SCHEDULED, and FAILED. 

Possible Errors

  • INVALID_DATAHTTP 400

    The job_id is invalid 
    Resolution: Specify a valid job ID.

  • REQUIRED_PARAM_MISSINGHTTP 401

    The job_id parameter in the request
    Resolution: Include the job_id key with a valid value you received in the response of the Mass Delete Tags API.

Sample Response

Copied{
    "mass_delete": [
        {
            "job_id": "2276164000001035002",
            "total_count": 8,
            "failed_count": 0,
            "deleted_count": 8,
            "status": "COMPLETED"
        }
    ]
}