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
Parameters
idpathrequiredAccount ID
Response
Account deleted successfully
Notes
⚠️This is permanent. All users will lose access to this account immediately.
💡Consider deactivating instead of deleting to preserve historical records.
Code Samples
Delete Account using the TypeScript SDK:
import { BackstageClient } from '@ticketlayer/backstage';
const client = new BackstageClient({
organisationSlug: 'your-org',
});
client.setAccessToken('YOUR_ACCESS_TOKEN');
// Delete account
await client.account.delete('{{ACCOUNT_ID}}');
console.log('Account deleted successfully');