updateById(id: string, patch: VariablePatch, options?: RequestScope): Promise<VariableResource>Patches one variable by id, with the same body and the same semantics as update. This is the better call for a sync client that already tracks ids, since it survives renames and needs no project or environment lookup.
value and defaultValue must be ciphertext when present, null clears defaultValue, and omitting a field leaves it untouched.
Note the ordering quirk, which is the reverse of the name addressed route: the variable is looked up before the ciphertext is validated, so a malformed value against an unknown id returns 404 rather than 400.
Example
const variable = await envless.variables.updateById('a7f2c1e0-8b4d-4c11-9f3a-2d5e6b7c8d90', {
required: false
})
console.log(variable.name, variable.required)Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Variable id from a list response or a webhook payload. |
patch.name | string | No | New name, matching ^[A-Za-z_][A-Za-z0-9_]*$ and 1 to 100 characters, rejected with 409 when another live variable holds it, compared without regard to case. |
patch.value | string | No | Replacement ciphertext from encryptValue, prefixed v1: or v2:. |
patch.type | string | No | One of the VARIABLE_TYPE values. |
patch.isSecret | boolean | No | Marks or unmarks the variable as a secret, which the example feed reports as secret. Stored, but not echoed in the response. |
patch.visibility | string | No | One of the VARIABLE_VISIBILITY_LEVELS values. |
patch.required | boolean | No | Toggles whether the variable is required for the environment. |
patch.defaultValue | string | null | No | Replacement ciphertext fallback, or null to clear it. |
options.signal | AbortSignal | No | Cancels the request. |
Returns
VariableResource for the patched variable, values still ciphertext.
Worth knowing
- This route is the only rename path that does not depend on knowing the project and environment slugs.
- A rename is checked locally before anything is sent. The new name must be 1 to 100 characters of letters, numbers and underscores, and it must not start with a number. Case is kept exactly as you type it, and a local refusal rejects with an
EnvlessApiErrorcarryingrequest.body_invalid.
Required scopes
variables:write
Underlying endpoint
PATCH /variables/{id}
Request and response schema, every error code, and a live playground.
In Python
envless.variables.update_by_id()
The same method in envless-sdk, the Python SDK, with the same request, retries and errors.
In Ruby
Envless.variables.update_by_id
The same method in envless-sdk, the Ruby gem, with the same request, retries and errors.
In PHP
$envless->variables->updateById()
The same method in envless/sdk, the PHP SDK, with the same request, retries and errors.