Change a setting

PATCH

/api/v1/settings/{key}

curl --request PATCH \
  --url 'http://localhost:3000/api/v1/settings/example?context=organization' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "additionalProperty": "example" }'

Starts from what applies now. A blank secret keeps the stored one; null clears it. Admin on that place.

Any caller; the scope needed is checked on what it acts on.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

key

required

string

E.g. email

Query Parameters

context

string

default: organization

Allowed values: organization project

Where

Request Body^required

Media typeapplication/json

Properties to change; a blank secret keeps it, null clears it

object

key

additional properties

Example^generated

{
  "additionalProperty": "example"
}

Responses

200

The setting

Media typeapplication/json

object

data

required

object

key

required

string

Allowed values: email branding

label

required

string

context

required

string

Allowed values: organization project

value

required

As it applies here; secret properties are null

object

key

additional properties

secrets

required

Whether each secret property is set

object

key

additional properties

boolean

source

required

The narrowest place any of it comes from

string

Allowed values: project organization environment default

sources

required

Where each property comes from

object

key

additional properties

string

Allowed values: project organization environment default

own

required

Set here: resetting it lets what is above apply

boolean

Example

{
  "data": {
    "key": "email",
    "context": "organization",
    "source": "project",
    "sources": {
      "additionalProperty": "project"
    }
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}