def update_by_id(id, patch = nil, timeout: nil, **fields)

def update_by_id: (
  String id,
  ?(variable_patch | Hash[Symbol | String, untyped])? patch,
  ?timeout: seconds?,
  **untyped
) -> variable_resource

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, nil 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

ruby

require "envless/sdk"

id = "a7f2c1e0-8b4d-4c11-9f3a-2d5e6b7c8d90"
variable = Envless.variables.update_by_id(id, required: false)

puts "#{variable[:name]} #{variable[:required]}"

Parameters

Parameter	Type	Required	Description
`id`	`String`	Yes	Variable id from a list response or a webhook payload.
`patch`	`variable_patch`	No	The fields below as one Hash, with Symbol or String keys, in place of the keywords.
`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.
`value:`	`String`	No	Replacement ciphertext from `encrypt_value`, prefixed `v1:` or `v2:`.
`type:`	`String`	No	One of the `Envless::VARIABLE_TYPE` values.
`isSecret:`	`bool`	No	Marks or unmarks the variable as a secret, which the example feed reports as `secret`. Stored, but not echoed in the response.
`visibility:`	`String`	No	One of the `Envless::VARIABLE_VISIBILITY_LEVELS` values.
`required:`	`bool`	No	Toggles whether the variable is required for the environment.
`defaultValue:`	`String \| nil`	No	Replacement ciphertext fallback, or `nil` to clear it.
`timeout:`	`Integer \| Float \| Rational`	No	Seconds each attempt of this call may take, redirects and the response body included, before it raises `Envless::NetworkError` with `timeout?` set. Overrides the client's `timeout` for this call, and `0` turns the limit off.

Returns

variable_resource 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 raises Envless::ApiError carrying request.body_invalid.

Required scopes

variables:write

Underlying endpoint

PATCH /variables/{id}

Request and response schema, every error code, and a live playground.

In TypeScript

envless.variables.updateById()

The same method in @goenvless/sdk, with the same request, retries and errors.

Example#

Parameters#

Returns#

Worth knowing#

Required scopes#

Underlying endpoint#