Delete a development workspace
Tears down a workspace you created, so a development environment can be reset and rebuilt. Built for exactly one job: letting your developers create and destroy throwaway registries while they build against us.
Sandbox only. This endpoint is not enabled in production and answers
403 delete_disabled there. Production workspaces hold real candidates;
removing one is a support request, not an API call.
Three conditions must all hold or nothing is touched:
- The workspace is linked to your partner account.
- You created it through
POST /organizations. A workspace CONFIRM linked to your account by hand — a real registry — can never be deleted here, and answers403 not_partner_created. - Deletion is enabled in the environment you are calling.
The workspace and everything in it (candidates, locations, the screening agent) is soft-deleted and can be restored by CONFIRM support. Nothing shared between registries is affected.
The external_ref is released. Calling POST /organizations again
with the same reference provisions a new workspace rather than
returning the deleted one, so teardown-and-recreate works as many times
as you need it to.
Authentication
Partner API key sent as Authorization: Bearer cfk_.... Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.
Path parameters
Response headers
The ID of this request. On an error it equals request_id in the body. If you sent an X-Request-Id, it is your value, returned unchanged. Log it, and quote it when contacting CONFIRM support.