Skip to main content
PATCH
Change Role in Sub-Organization

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the parent organization

sub_org_id
string
required

The ID of the sub-organization

Body

Schema for joining a sub-organization with a chosen role

role
enum<string>
required

Role to assign when joining the sub-organization

Available options:
ADMIN,
DEVELOPER,
MANAGER,
STAFF

Response

200 - application/json

The sub-organization after the role has been updated.

Summary information about a sub-organization

id
string
required

Unique identifier of the sub-organization

name
string
required

Name of the sub-organization

logo_url
string | null
required

URL of the sub-organization logo

plan
enum<string>
required

Type of subscription plan

Available options:
free,
business
balance
number
required

Current credit balance

promo_balance
number
required

Current promotional credit balance

billing
object
required

Schema for updating payment configuration

members
object[]
required

Members of the sub-organization

spending_cap_used
number
required

Amount spent in the current month

created_at
string<date-time> | null
required

Timestamp when the sub-organization was created

features
object

Org gate-keeping features configuration

config
object

Organization configuration settings