Delete a Holiday

Purpose

To delete the holidays set for your org.

Endpoint

Request Details

Request URL

{api-domain}/crm/{version}/settings/holidays/{holiday_id}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
X-CRM-ORG:{your_org_id}

Scope

scope=ZohoCRM.settings.business_hours.ALL
(or)
scope=ZohoCRM.settings.business_hours.DELETE

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v5/settings/holidays/3652397000011199002"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-H "X-CRM-ORG: {your_org_ID}"

Possible Errors

  • INVALID_DATAHTTP 400

    The holiday ID is invalid.

    Resolution:
    Use the Get Holidays API to get the ID of the holiday you want to delete.

  • API_NOT_SUPPORTEDHTTP 400

    You are trying the API from API version 2 or below.
    Resolution: This API is supported only from API version 2.1 and up.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    You do not have the right scope to access this API.
    Resolution: Create new token with ZohoCRM.settings.business_hours.ALL or ZohoCRM.settings.business_hours.DELETE scopes.

  • INACTIVE_USERHTTP 403

    You are an inactive user in the org.
    Resolution: Inactive users cannot access this API. Contact the administrator.

  • NO_PERMISSIONHTTP 403

    You are not an admin.
    Resolution: Only admin users can set the holidays for the org.

  • 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 the request URL section above.

Sample Response

Copied{
    "holidays": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000011199002"
            },
            "message": "Holiday deleted successfully",
            "status": "success"
        }
    ]
}