Delete a tag

Delete an existing tag using the tag ID.

Endpoints

Request URL

{api-domain}/bigin/v2/settings/tags/{tag_id}

Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

For US, https://www.zohoapis.com
For EU, https://www.zohoapis.eu
For AU, https://www.zohoapis.com.au
For IN, https://www.zohoapis.in
For CN, https://www.zohoapis.com.cn
For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

Authorization

For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with one of the following scopes:

ZohoBigin.settings.ALL
ZohoBigin.settings.tags.ALL
ZohoBigin.settings.tags.WRITE
ZohoBigin.settings.tags.DELETE

Request parameters

The available request parameters are given below:

Path parameters

tag_id stringRequired

The unique identification (tag ID) of a tag. You can get the tag IDs from the Get tags API.

Sample request

Copiedcurl "https://www.zohoapis.com/bigin/v2/settings/tags/2034020000000489005" \
-X DELETE \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/settings/tags/2034020000000489005"
	type: DELETE
	connection:"connection_link_name"
];
info response;

Response object

The response object includes details regarding success and status messages.

Possible error codes

The response of this resource includes HTTP status and error codes.

The most common HTTP error codes that occur when you request access to this endpoint are given in the following:

INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoBigin.settings.tags.DELETE scope. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to delete tags
Resolution: The user does not have permission to delete tags. Contact your system administrator.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team.
INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.
AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to delete tags
Resolution: The user does not have the permission to delete tags. Contact your system administrator.
INVALID_DATAHTTP 400
tags not found
Resolution: The tag ID specified in the URL is invalid. Refer to Get Tags API to get valid tag IDs.

Sample response

Copied{
    "tags": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "2034020000000489005"
            },
            "message": "tags deleted successfully",
            "status": "success"
        }
    ]
}