Operation
Delete Account
DELETE
/accounts/{id}Remove an account from your organisation.
This permanently deletes the account and removes access for all users assigned
to it. Events and historical data may be preserved depending on your
organisation's data retention policies.
Think carefully before deleting-if a promoter is leaving your platform or a
department is closing, you might want to deactivate rather than delete to
preserve records.
When to use this
- Removing a promoter who's left your platform
- Cleaning up test accounts
- Consolidating accounts after a restructure
Path parameters
idstringRequired- Account ID
Headers
Idempotency-KeystringOptional- Makes the write safe to retry. The first request with a key does the work and its response is stored for 24 hours; a repeat with the same key and the same request (method, path, query, X-Ticketlayer-Channel, TL-Version and body) gets that stored status and body back, marked `Idempotent-Replay: true`, without running again. The key is scoped to your organisation and your credential. The same key with a different request is 422 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running waits for it, then answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS if it has not finished. Only a 2xx is stored: after an error the key is free again. Omit the header and the request behaves as it always has.
Returns
Account deleted successfully
Errors
- 400
- Bad Request - Invalid input
- 401
- Unauthorized - Authentication required
- 403
- Forbidden - Insufficient permissions
- 404
- Not Found - Resource not found
- 500
- Internal Server Error
Every error names its code and links to it. All error codes
Notes
Important
This is permanent. All users will lose access to this account immediately.
Tip
Consider deactivating instead of deleting to preserve historical records.
Related
import { BackstageClient } from '@ticketlayer/backstage';const client = new BackstageClient({ organisationSlug: 'your-org',});client.setAccessToken('YOUR_ACCESS_TOKEN');// Delete accountawait client.account.delete('{{ACCOUNT_ID}}');console.log('Account deleted successfully');Response 200
{
"success": true,
"id": "acc_abc123"
}