Change a setting
Changes one of the key's person's own settings.
An API key may change translate_cards only; any other answers not_for_client. Refused when the setting changed since it was read.
Authorization
Authorization: Bearer <key> Authentication
Body
An id the caller makes for this request. Sent again with the same request, it returns the first answer and changes nothing twice; sent with a different request, it is refused.
The setting's name.
The setting's new value.
The setting's version as last read, 0 for one never set; when it changed since, the change is refused.
Response
200 The setting after the change.
The setting's name.
The setting's value.
The setting's version, which a change sends as expectedVersion; 0 for one never set.
When it last changed, or null when never set.
True when the caller may change it.
Errors
invalid_query The query is not in the form the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).invalid_setting The setting, its value or the read of its history is not one the route takes; the limit is in the unit of the input details.field names (characters for a text, entries for a list, the value for a number).session_revoked The request carries no session the server holds, or its session has ended.session_expired The session has expired.not_for_client The route, setting or input the request names is open only to Werk's own apps, and the request's session is a connected app's or an API key's.not_found The route or record the request names does not exist, or is not one the signed-in person can reach.session_changed The session changed while the request was in flight.setting_version_conflict The setting changed after the version the request names.request_conflict The request id was already used with another request, or the change it asks could not be made to the record it names.request_erased The request id belongs to a request whose record was erased.payload_too_large The request body has more bytes than the route takes.rate_limited More requests of this kind were sent than Werk takes within the time it counts them over.server_error The server could not complete the request, and it is not known whether a write it holds was made.curl -X POST "https://api.getwerk.ai/api/v1/settings" \
-H "Authorization: Bearer wk_key_..." \
-H "Content-Type: application/json" \
-d '{
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4c06",
"key": "translate_cards",
"value": false,
"expectedVersion": 1
}'const res = await fetch("https://api.getwerk.ai/api/v1/settings", {
method: "POST",
headers: {
Authorization: "Bearer wk_key_...",
"Content-Type": "application/json",
},
body: JSON.stringify({
"clientRequestId": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4c06",
"key": "translate_cards",
"value": false,
"expectedVersion": 1
}),
});
const answer = await res.json();{
"key": "translate_cards",
"value": false,
"version": 2,
"updatedAt": "2026-11-21T14:05:00.000Z",
"canWrite": true
}Send a requestPOST
It is sent with the key you give, as you. A change made here is real.
The request could not be sent, or its response could not be read.