Setting routes: update, delete

Reference for Setting, one group of Setting routes.

Setting.update

Changes the given properties of a Setting. Verb page.

Text

PATCH /{namespace}/settings/{id}

Path: id. Body, as JSON: the other inputs. Emits Setting.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Setting.
`key`	`string`		The name of the choice.
`value`	`json`		The chosen value.
`locked`	`boolean`		True when no holder below may override it.

Returns

Output	Type	Required	Description
`setting`	Setting	required	The Setting.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/settings/setting_mfZPXxFQYD \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":{}}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "setting": {
    "$id": "https://api.sb/leaseline.app/settings/setting_mfZPXxFQYD",
    "$type": "Setting",
    "key": "Example key",
    "value": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Setting.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Setting.delete

Deletes a Setting: a soft delete that keeps its history, undone by Thing.restore. Verb page.