Resetting your tenant
For integration engineers who want to return their sandbox organisation to a known starting state.
A reset changes the starting state of a sandbox evaluation. The public API has no whole-organisation reset endpoint. Request any environment-wide reset through the operator process agreed during onboarding; do not try to simulate one by deleting unrelated resources or submitting compensating token operations.
Prepare before a reset
- Stop your test submitter and disable scheduled test automations through the agreed administrative process.
- Reconcile in-flight operations and outstanding locks. A local timeout is not a confirmed failure.
- Export the transaction, approval, webhook and audit evidence your test report needs.
- Agree the reset scope with the operator: users, credentials, customer/account records, contracts, balances, locks, policies, scripts, automations and webhook registrations.
- Agree when requests can resume and how the replacement fixture inventory will be supplied.
Platform records and on-chain value are separate. Clearing registry records does not by itself clear a contract's balances or release locked funds. Confirm the ledger and custody treatment explicitly before restarting tests.
Clean up individual test resources
Where a full reset is unnecessary, use the documented resource lifecycle operations with the appropriate administrator identity.
| Resource | Operation | Important distinction |
|---|---|---|
| Customer | PATCH /api/customers/{customerRef} | Changes status; it is not deletion of the customer's transaction history. |
| Account | PATCH /api/accounts/{accountRef} | Changes status; it does not burn tokens or unwind a lock. |
| Webhook | DELETE /api/webhooks/{id} | Removes the registration and stops its event delivery. |
| Automation | DELETE /api/automations/{automationId} | Follow its documented lifecycle and dependency rules. |
| Script | DELETE /api/scripts/{scriptId} | Read the effect on linked automations before removing it. |
| Policy | POST /api/policies/{policyId}/archive | Archives the policy; it does not reverse already settled operations. |
Retain idempotency keys on the writes that require them. Read Idempotency and retries before retrying cleanup after an uncertain response.
Verify the new starting state
Repeat Seed data reference, read account balances and contract/account statuses, and test the event receiver again. Replace obsolete fixture identifiers in your harness. Keep a record of the operator-confirmed reset scope so later balance or audit differences can be explained.
API Reference
Open an endpoint for request fields, response examples and the interactive API console.
| Operation | Method |
|---|---|
| Activate or deactivate a customer | PATCH |
| Activate or deactivate an account | PATCH |
| Delete a webhook registration | DELETE |
Related pages
Updated 5 days ago