Delete Agency Client
Permanently delete a client workspace and its data.
https://api.foxreach.io/Requires an API key with the write scope.
Only API keys of an Agency workspace can call this endpoint (403 agency_required otherwise). The call always runs in the key's own workspace; X-Workspace-Id is ignored. Writes also need a key created by the agency workspace owner (403 agency_owner_required otherwise).
This cannot be undone. The workspace is removed with its leads, campaigns, email accounts and every other record. A key cannot delete the workspace it belongs to (400 cannot_delete_own_workspace), and personal workspaces cannot be deleted.
Path Parameters#
client_idstringpathrequiredResponse#
dataobjectShow data
idstringdeletedbooleantrue.Each delete is recorded as an audit.agency_client.deleted event on the agency workspace before the data is removed.
Errors#
| Status | Description |
|---|---|
401 | Missing, invalid, revoked or expired API key |
403 | API key does not have the required scope: write |
400 | cannot_delete_own_workspace, or the workspace is personal |
403 | agency_required or agency_owner_required |
404 | The workspace is not owned by the agency owner |
Rate Limit#
- 120 requests per minute, shared by every
writecall in your workspace. Fixed 60-second window. - Every response includes
X-RateLimit-Limit,X-RateLimit-Remaining,X-RateLimit-Reset(unix epoch seconds) andX-RateLimit-Bucket(write). - A
429response includes aRetry-Afterheader (seconds until the bucket resets).
For client-side patterns, see Rate Limiting.