Delete Variables API

Suggest Edits

Overview

The Delete Variables API endpoint allows you to delete variables individually or all at once.

Endpoint

Here is a sample endpoint from the account in the India region:
https://in1.api.clevertap.com/1/deleteVars

Authentication

Authentication is required using accountId and passcode headers.

Headers

Refer to Headers for more details.

Region

Refer to Regions to view region-specific sample endpoints

HTTP Method

The HTTP method is POST for the Delete Variables API

Body Parameters

Parameter	Description	Type	Example	Required/Optional
deleteAllVars	Determines whether you want to delete all variables in your Remote Config.	Boolean	{ "deleteAllVars": false }	Optional
variableNames	Contains a list of variable names you want to delete from your Remote Config.	String	{ "variableNames": ["var1", "folder1.var2", "non.existing"] }	Required

Sample Request

curl -X POST -d '{"variableNAmes":["var1","folder1.var2"]}' "https://in1.api.clevertap.com/1/deleteVars" \
-H "X-CleverTap-Account-Id: ACCOUNT_ID" \
-H "X-CleverTap-Passcode: PASSCODE" \
-H "Content-Type: application/json; charset=utf-8"

Sample Response

{
    "status": "success",
    "deletedVariables": [
        "var1",
        "folder1.var2"
    ],
    "problematicVariables": [
        "non.existing"
    ]
}

Updated 9 months ago