Skip to content

Create child organization

POST
/children

Create a new child organization under the parent organization associated with the integration token

Request to create a child organization

object
newOrgName
required

Name of the new child organization

string
newUser
required

Information about the admin user for the new organization

object
email
required

Email of the admin user

string format: email
name
required

Name of the admin user

string
sendInvitation
required

Whether to send an invitation email to the admin user

boolean

Child organization already exists

Response when the child organization already exists

object
organizationId

UUID of the existing child organization

string

Child organization created

Response when a new child organization is created

object
organizationId

UUID of the created child organization

string

Parent organization cannot have children

Request failure

object
errorMessage
string

Access token is missing or invalid

Request failure

object
errorMessage
string