Put Settings
Replace an organisation's own settings.
โถRequest
โถMethod & Path
PUT /organizations/:id/settings
โถPath parameters
idโ any organisation in the caller's scope: its own, or a child.
โถHeaders
x-api-keyโ API key.Content-Typeโapplication/json.x-acting-asโ optional child organisation ID.
โถBody
data.attributes.settings replaces the organisation's own settings. A key
left out inherits the parent's value. To stop inheriting one key, send that
key as an empty list, e.g. { "dashboard_tags": [] }. Send {} to inherit
every key.
packaging_rulesโ optional, at most 20, one pertarget.targetโ lowercase dot-separated words, e.g.eudr.dds, max 64.selectorโ tag selector for the locations the rule takes, max 1000.group_byโ tag namespace.
dashboard_tagsโ optional, at most 50, eachnamespaceonce.namespaceโ tag namespace.labelโ display label, max 100.filterableโ boolean.
A tag namespace is lowercase letters, digits, underscore or hyphen, with no colon, max 64 characters. Any other key, at any level, is a 400.
The response is the same resource as GET /organizations/:id/settings,
read after the write.
โถErrors
| Status | Code | Meaning |
|---|---|---|
| 400 | VALIDATION_ERROR | Unknown key, bad namespace, repeated target or namespace, or an id that is not a UUID. |
| 401 | Missing or invalid API key. | |
| 403 | The key does not hold organizations:write. | |
| 404 | NOT_FOUND | The organisation is not in this key's scope. |
Required scope:
organizations:write