Docs

Create Child Organization

Create a new organization as a child of your company. It starts with no members: invite people with Create Invitation while sending the new id in X-Company-Id, which can seat its first Owner. The key's creator needs child_company:manage.

POST

Headers

Optional headers
string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. Here a key acts in another organization only as one of its members: with "Use this key across all of your organizations" on, in an organization its creator belongs to with a role. Child organizations and MindCloud staff access do not reach this endpoint. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments
stringrequired

The new organization name, up to 128 characters. Names are unique across MindCloud.

string

A description, up to 2048 characters.

Response fields

idstring

The child organization's id. Send it in X-Company-Id to call other endpoints on the child.

namestring

The child organization's name.

descriptionstring

The child organization's description.

originstring

created when your company created it through the API, linked when an existing organization accepted your company as its parent in Cirra.

  • created
  • linked
linkedOndate

When the link started.

memberCountnumber

Members of the child organization, including pending invites.

ownerCountnumber

Active Owners. A child cannot be released while this is 0.