Skip to main content
Update an organisation's profile

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Encoding
enum<string>
Available options:
gzip,
base64,
gzip, base64

Path Parameters

org_id
string
required

Body

application/json
name
string | null

Response

HTTP 200 response.

allow_local_sync
boolean
required
allowed_auth_methods
enum<string>[]
required
Available options:
magic_otp,
google,
enterprise_sso
created_at
string<date-time>
required
id
string
required
join_policy
string
required
name
string
required
organisation_type
enum<string>
required
Available options:
customer,
platform
restrict_invites_to_domains
boolean
required
revoke_credentials_on_offboard
boolean
required
slug
string
required
status
enum<string>
required
Available options:
active,
suspended,
pending_deletion,
archived
updated_at
string<date-time>
required
version
integer<int64>
required
created_by
string
workos_organization_id
string