DevelopersHow to connect an assistantKeys
Reference/Profile/Change

Change a setting

POSThttps://api.getwerk.ai/api/v1/settings

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

AuthorizationheaderRequired

Authorization: Bearer <key> Authentication

Body

clientRequestIdstring, uuidRequired

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.

keyenumRequired

The setting's name.

Allowed valuesbrief_timebrief_onbrief_resume_dateemail_due_noticesemail_own_remindersemail_invitationspush_my_cardspush_due_noticespush_own_reminderspush_invitationspush_project_peoplepush_from_werktranslate_cardstranslate_offercards_drawer_levelquiet_hours_onquiet_startquiet_endquiet_daysquiet_untildue_notice_leadcolorhighlightedmutedin_morning_brieftranslate_offer_closed
valueboolean or nullRequired

The setting's new value.

expectedVersionintegerRequired

The setting's version as last read, 0 for one never set; when it changed since, the change is refused.

From 0 to 2147483646

Response

200 The setting after the change.

keyenum

The setting's name.

Allowed valuesbrief_timebrief_onbrief_resume_dateemail_due_noticesemail_own_remindersemail_invitationspush_my_cardspush_due_noticespush_own_reminderspush_invitationspush_project_peoplepush_from_werktranslate_cardstranslate_offercards_drawer_levelquiet_hours_onquiet_startquiet_endquiet_daysquiet_untildue_notice_leadcolorhighlightedmutedin_morning_brieftranslate_offer_closed
valueboolean or null

The setting's value.

versioninteger

The setting's version, which a change sends as expectedVersion; 0 for one never set.

At least 0
updatedAtstring, date-time or null

When it last changed, or null when never set.

canWriteboolean

True when the caller may change it.

Errors

400invalid_queryThe 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).
400invalid_settingThe 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).
401session_revokedThe request carries no session the server holds, or its session has ended.
401session_expiredThe session has expired.
403not_for_clientThe 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.
404not_foundThe route or record the request names does not exist, or is not one the signed-in person can reach.
409session_changedThe session changed while the request was in flight.
409setting_version_conflictThe setting changed after the version the request names.
409request_conflictThe request id was already used with another request, or the change it asks could not be made to the record it names.
409request_erasedThe request id belongs to a request whose record was erased.
413payload_too_largeThe request body has more bytes than the route takes.
rate_limitedMore requests of this kind were sent than Werk takes within the time it counts them over.
500server_errorThe server could not complete the request, and it is not known whether a write it holds was made.
curl
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
  }'
TypeScript
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();
200JSON
{
  "key": "translate_cards",
  "value": false,
  "version": 2,
  "updatedAt": "2026-11-21T14:05:00.000Z",
  "canWrite": true
}