Update Setting

PUT 
/api/v2/settings/:slug

Updates a single setting by slug. Body shape varies per slug — for simple settings the body is {"value": ...}; for grouped settings (e.g. purchase-order, forecasting, general) the body is a flat object of allowed keys.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Slug purchase-order accepts:

• cc_outgoing_email (string|null, max 500) — comma-separated CC list applied to outgoing PO emails.

Slug general accepts (validated keys):

• connectivity_alert_sound_enabled (boolean) — play a repeating audio alert on the device when the app loses connection to the server, and a confirmation tone when restored. Non-boolean values are rejected with 422.

Authentication: Requires Bearer token.

Requires permission: settings.update

Request

Responses

200

OK

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Unprocessable Entity

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.