Deletes a project.

With a project API token, only subprojects can be deleted; targeting the root project returns 422 only_subprojects_can_be_deleted. With a Personal access token, a root project can be deleted as well.

In both cases the project must be empty first: remove its subprojects (subprojects_must_be_removed) and its phone numbers (phone_numbers_must_be_removed). The last remaining project in a space cannot be deleted (last_project_cannot_be_deleted).

On a successful subproject delete, the subproject's registry brands and campaigns are migrated up to the parent project.

Use this operation only for a project that is ready to retire. The Compatibility API cannot close an account; its Update account operation only renames one, so deleting the project here is the API path for retiring it.

Permissions

With a project API token, the token must have the following scope(s) enabled to make a successful request: Management.

With a Personal access token there are no scopes. The token holder must be an owner or admin of the space, and the request reaches only the projects the holder is enabled for, plus their subprojects.

Learn more about API scopes.