Update current organization

Update the current user’s organization

PATCH /api/v1/org

Error

A valid request URL is required to generate request examples

200

{
  "status": "ok",
  "results": "<unknown>"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Body

application/json

the new organization settings

the new organization settings

name · string

The name of the organization

colorPaletteUuid · string

The active color palette uuid for all projects in the organization

createdAt · string<date-time>

chartColors · string[]

The default color palette for all projects in the organization

chartDarkColors · string[]

The default dark color palette for all projects in the organization

defaultProjectUuid · string

The project a user sees when they first log in to the organization

pgWire · object

Postgres wire protocol connection details for the semantic layer, only populated on the authenticated GET /org response (not the public health endpoint). enabled reflects whether the instance exposes a pgwire port and is returned to every org member; host/port are the infra endpoint clients connect to and are only populated for org admins (null otherwise).

Show child attributes

Response

200

application/json

Ok

status · enum<string> · required

Available options: ok

results · any