Delete Webform A/B Testing

Purpose

To delete a Webform A/B Testing configured in your Zoho CRM organization.

Endpoints

DELETE /settings/AB_testing/{AB_testing_ID}

Request Details

Request URL

{api-domain}/crm/{version}/settings/AB_testing/{AB_testing_ID}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.abtest.ALL
(or)
ZohoCRM.settings.abtest.DELETE

Parameters

modulestring, mandatory
Specify the module API name of the webform A/B Testing that you want to delete.

Notes

Deleting an A/B test is permanent. The test configuration and all metrics collected for it are removed and cannot be recovered.
The variant webforms that were created as part of this A/B test are deleted along with the test. Variants are configured and owned by the A/B test — they are not stand-alone webforms.
The base (original) webform referenced by base_form.id is not deleted. Only the A/B test and its variants are removed.
An A/B test can be deleted from any lifecycle state (drafted, scheduled, running, paused, completed, or launched). If the test is currently running or paused, the deletion stops serving variants immediately and all visitors are directed to the base webform.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/AB_testing/4794410000000772294?module=Leads"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X DELETE

Possible Errors

INVALID_DATAHTTP 400
The {AB_testing_ID} in the URL is not a valid ID, or no A/B test with that ID exists in the specified module (for example, the ID belongs to a different module or has already been deleted).
Resolution: Verify the A/B test ID using the Get A/B Testing API and ensure the ID belongs to the module supplied in the module query parameter.
INVALID_MODULEHTTP 400
The value supplied for the module query parameter is not a valid CRM module name (for example, a typo, an unsupported module, or a module the current user cannot access).
Resolution: Specify a valid module API name. Webform A/B testing is currently supported for the Leads module.
REQUIRED_PARAM_MISSINGHTTP 400
The required module query parameter is missing from the request.
Resolution: Include the module query parameter with a valid module API name.
INVALID_REQUEST_METHODHTTP 400
The HTTP method used is not supported for this endpoint.
Resolution: This API supports only the DELETE method. Retry the request using DELETE.
OAUTH_SCOPE_MISMATCHHTTP 401
The access token used does not have the required OAuth scope.
Resolution: Use a token with ZohoCRM.settings.abtest.DELETE or ZohoCRM.settings.abtest.ALL scope. Refer to the Scope section for details.
INVALID_URL_PATTERNHTTP 404
The request URL is malformed or does not match the expected pattern.
Resolution: Verify the URL. Refer to the Request URL section for the correct pattern.
INTERNAL_ERRORHTTP 500
An unexpected error occurred on the server.
Resolution: Retry the request after some time. If the error persists, contact Zoho support.

Sample Response

Copied{
    "AB_testing": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "4794410000000772294"
            },
            "message": "ABTesting deleted successfully",
            "status": "success"
        }
    ]
}