Delete Custom Variable

Deletes a custom variable by its ID. Impact: Any agent instructions referencing this variable will no longer resolve its value.

DELETE /ai-agents/agent-builder/agents/variables/custom/{variableId}

Delete Custom Variable

cURL

curl --request DELETE \
  --url https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/agents/variables/custom/{variableId} \
  --header 'apikey: <api-key>'

200

{
  "success": true,
  "message": "Variable deleted successfully"
}

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key (i.e. Rest API Key from the Dashboard).

Path Parameters

variableId · string · required

Variable ID to delete

Response

200 - application/json

Custom variable deleted successfully

success · boolean · required

Indicates whether the operation was successful

Example:

true

message · string · required

Human-readable result message

Example:

"Operation completed successfully"