Skip to main content
PATCH
/
orgs
/
{org_id}
/
settings
Update Org Settings
curl --request PATCH \
  --url https://api.yertle.com/orgs/{org_id}/settings \
  --header 'Content-Type: application/json' \
  --data '
{
  "invite_mode": "open",
  "is_public": true
}
'
{
  "invite_mode": "<string>",
  "is_public": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.yertle.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
authorization
string | null

Path Parameters

​
org_id
string
required

Body

application/json

Request model for updating organization settings.

​
invite_mode
enum<string> | null

Invite mode

Available options:
open,
restricted
​
is_public
boolean | null

If true, the org becomes anonymously readable via /public/... routes

Response

Successful Response

Response for PATCH /orgs/{org_id}/settings.

Only the fields that were updated in this request are populated; others are omitted (None). The handler builds the response from the service layer's per-field result dict.

​
invite_mode
string | null

Current invite mode (if changed)

​
is_public
boolean | null

Current is_public flag (if changed)