API Stability Short-Term

The removeOrganization() GraphQL mutation is used to remove an organization with the given identifier. It must be the same organization as the requesting user is in. It requires root access to execute.

For more information on organization settings, see the Organization Settings documentation page.

Syntax

Below is the syntax for the removeOrganization() mutation field:

graphql
removeOrganization(
      organizationId: string!
   ): boolean!

Below is an example of how this mutation field might be used:

Show:
graphql
mutation {
  removeOrganization(
    organizationId: "123abc"
  )
}
Example Responses
Show:
json
{
  "data": {
    "removeOrganization": true
  }
}

There are no special datatypes for this mutation field.