Delete agent variable
Deletes a variable with a fixed value and returns its name. It is refused while an active campaign of the agent (running or paused) would be left without a value it needs. Renaming a variable is deleting it and creating it again, so the same rule applies. It also accepts the exact name of a legacy variable listed with valid: false, URL-encoded. Required scope: agents:operate. With a test key (vx_test_) it is simulated: nothing real happens and nothing is billed. Accepts an optional Idempotency-Key header. Retriable: when the operation itself fails with a 429, a 5xx or a temporary 409, the key is released and a retry with the same key runs the operation again; with no response at all, a retry with the same key returns the first outcome or runs the operation again. A 429 rate_limited from the request limit and 409 request_in_progress come before the operation and leave the key as it is: retry with the same key.
Authentication
Path parameters
Id of an agent of the organization, as returned by GET /agents.
The exact name of the variable, URL-encoded. Any name returned by the list is accepted, including legacy names with valid: false.
Headers
API version for this request; defaults to the version the key is pinned to.
A unique value you generate for each new operation (16 to 64 letters, digits, hyphen or underscore; a UUID works). Repeating the same request with the same key within 24 hours returns the first response and does nothing again, when that response was a success or a 4xx error the same request would always get again (not 429, and not the temporary 409 codes request_in_progress, caller_has_active_call and caller_request_in_progress: for those, and for a 5xx, see the note on retrying in the operation); the same key with a different request is refused with idempotency_key_reused.
Response
Always agent_variable.
Always true.
true when the request was made with a test key: every check ran but nothing was changed. false with a live key.