Update a variable
Example request
Generated- cURL
- JavaScript
- TypeScript
- Python
- PHP
- Go
- Java
- Ruby
- C#
Responses
Updates the supplied fields and leaves the rest untouched. Every article and clip using the variable shows the new value the next time it is rendered. Only a member who can share clips may lock or unlock a variable, so is_locked is ignored from an API key, and a locked variable cannot be changed with one.
Authentication
-
-
ApiKeyBearerhttpbearerAn API key sent as
Authorization: Bearer <key>. A key holds scopes, the same ones OAuth uses, and an operation needs the scope listed for it under OAuth2. A key may also expire, or be revoked or rotated in Settings > API, after which it is refused with a 401.
-
-
-
OAuth2oauth2An OAuth 2.0 access token for an app acting on behalf of a HelpDocs user, sent as
Authorization: Bearer <token>. The authorization code flow requires PKCE (S256). Each operation names the one scope it needs.
-
Path parameters
-
variable_idstring Required
Request body Required
The fields to change.
application/json
UpdateVariableRequest
-
titlestring NullableNull is the same as leaving the field out.
-
valuestring NullableNull is the same as leaving the field out.
-
is_lockedboolean NullableNull is the same as leaving the field out.
{
"title": "string",
"value": "string",
"is_locked": true
}
Generated from the schema
Responses
The updated variable.
application/json
VariableResponse
The request was rejected: a required field is missing from the body, or a value in it is not acceptable.
text/plain
The failure, as a human-readable message.
-
string
The failure, as a human-readable message.
Authentication failed or no API key was supplied.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
The account’s billing is past due and writes are locked. Reads keep working; editing resumes once billing is settled.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
The key lacks write permission, or the account’s plan does not include API access.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
No such resource in this account, or variable_id does not match the pattern this route accepts.
text/plain
The failure, as a human-readable message.
-
string
The failure, as a human-readable message.
Rate limited. Wait the number of seconds in Retry-After before trying again. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset say which allowance was spent and when it refills.
-
Retry-Afterinteger -
X-RateLimit-Limitinteger -
X-RateLimit-Remaininginteger -
X-RateLimit-Resetinteger
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.