Skip to content
em sa em sa

Update Org

PATCH
/api/orgs/{org_id}
 
curl --request PATCH \
  --url https://example.com/api/orgs/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "settings": {} }'

Update organization name and/or settings.

Settings are merged (existing keys preserved). Requires owner/admin role.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
org_id
required
Org Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
PatchOrgRequest
object
name
Any of:
string
settings
Any of:
object
key
additional properties
any
Example generated
{
  "name": "example",
  "settings": {}
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
OrganizationResponse
object
id
required
Id
string
org_id
required
Org Id
string
name
required
Name
string
slug
required
Slug
string
settings
required
Settings
object
key
additional properties
any
status
required
Status
string
created_at
required
Created At
string
updated_at
required
Updated At
string
member_count
Any of:
integer
Example generated
{
  "id": "example",
  "org_id": "example",
  "name": "example",
  "slug": "example",
  "settings": {},
  "status": "example",
  "created_at": "example",
  "updated_at": "example",
  "member_count": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}