403 Forbidden

Setting locked

Code

setting_locked

Status

403 Forbidden

Type

https://errors.clavian.io/setting-locked

What it means

HQ has locked this setting for the Platform or for the organisation, so it cannot be changed at this scope. detail names the scope that holds the lock.

What to do

Show the setting as locked and read only. Only a change at the scope that holds the lock can change it.

Example

The API answers with status 403 and this body, as application/problem+json. A detail may be added, saying what went wrong this time; it is for people, and changes.

{
  "type": "https://errors.clavian.io/setting-locked",
  "title": "Setting locked",
  "status": 403,
  "code": "setting_locked",
  "requestId": "req_01k5znw4hmfay8vvr14d2pf2db"
}

Endpoints that return it

From the OpenAPI document, every endpoint that names it among its answers:

• PUT /v1/hq/organizations/{organizationId}/settingsSet, lock or unlock an organisation’s settings, as HQ
• PUT /v1/organizations/{organizationId}/settingsChange the organisation’s settings
• PUT /v1/organizations/{organizationId}/venues/{venueId}/settingsChange a venue’s settings