1. Docs
  2. API Reference
  3. Delete an organization

Delete an organization

DELETE/api/v1/organizations/{id}

Deletes an organization by id: removes every membership, revokes every pending invitation bound to it, and soft-deletes the organization. Member identities themselves are untouched and keep their memberships in other organizations. Supports optimistic concurrency via the If-Match header (409 on a version mismatch). Responds 204 No Content, requires the hierarchy.manage permission at the organization, and emits organization.deleted.

Authentication

Bearer TokenAuthorization Option A

JWT access token

API KeyX-API-Key Option B

API key for management-tier access

Path Parameters

idstring Required

Headers

  • if-match required
  • If-Match

    Optimistic-lock version of the resource. Send the `version` field returned on read; the server rejects with 409 if the row has changed since.

Responses

Organization deleted

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X DELETE "https://auth.canopy-io.com/api/v1/organizations/value" \
  -H "if-match: value" \
  -H "If-Match: value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
HTTP/1.1 204 Organization deleted

(empty body)
 Related endpoints
GETList organizations
POSTCreate an organization
GETGet an organization
PATCHUpdate an organization
GETList an organization's members
POSTAdd a member to an organization
PATCHChange a member's role
DELETERemove a member from an organization
GETList an organization's invitations
POSTInvite a member into an organization
DELETERevoke an organization invitation
 Was this page helpful?

Tell us how we can improve this guide.

Canopy