Delete an organization

This is for:

System Administrator
In this article

You’ll rarely (if ever) need to delete a Coveo organization, unless you originally created this organization for a specific purpose such as testing, and this purpose is now finished. In such a case, you may delete the obsolete organization.

Warning

Deleting a Coveo organization is permanent. Make sure you know what you’re doing before you perform this call.

Use the Delete an organization operation to permanently remove a specific organization from the Coveo Platform.

You can also perform this action from the Coveo Administration Console Settings page. See Organization details.

Notes

  • You can’t delete an organization that’s in read-only mode. Often, this means that your organization is inactive, and you need to reactivate it first.

  • Upon deletion, Coveo keeps your organization backup until the end of the retention period. If an organization is restored within the retention period, the data will still be available.

Request template

DELETE https://platform.cloud.coveo.com/rest/organizations/<MyOrganizationId> HTTP/1.1

Accept: application/json
Authorization: Bearer <MyAccessToken>

In the request path, replace <MyOrganizationId> with the ID of the target Coveo organization.

In the Authorization HTTP header, replace <MyAccessToken> with an access token that grants the privilege to edit the target Coveo organization (that is, the Edit access level on the Organization domain). See Manage privileges, Get the privileges of an access token, and Get your Coveo access token for details.

A successful response (204 No Content) signifies that the target organization no longer exists in Coveo.

Note

It’s only possible to delete an organization with an access token associated with a user. It’s not possible to use any other type of authentication (such as API key, Platform token, etc.) to do so.

Sample request

Request - Deleting the mycoveocloudv2organizationg8tp8wu3 organization

DELETE https://platform.cloud.coveo.com/rest/organizations/mycoveocloudv2organizationg8tp8wu3 HTTP/1.1

Accept: application/json
Authorization: Bearer **********-****-****-****-************

Successful response - 204 No Content

{}