Skip to main content
Update an organization

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Body

application/json
onboarding_complete
enum<boolean>
Available options:
true
name
string
Required string length: 1 - 100
slug
string
Required string length: 1 - 100
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
settings
object

Response

The updated organization.

id
string
required
Required string length: 1 - 255
name
string
required
slug
string | null
required
logo_url
string | null
required
email_slug
string
required
settings
object
required
onboarding_complete
boolean
required
access
object
required
members_count
integer
required
Required range: x >= 0
capabilities
object
required
member_limit
integer | null

Maximum number of members. Null means unlimited; omitted when not yet known.