post
https://api.everee.com/integration/v1/partner/companies//retire
Retire a Sandbox company you no longer need.
Use this endpoint to retire a Sandbox company you created and no longer need. Call it with your test key.
A retired company is kept, but its company API keys stop working immediately, it is no longer reachable through the Company Onboarding API (requests for it return 404), and it no longer counts toward the number of Sandbox companies you can have alive at once. It still counts toward the number you can create in any rolling 7 days, so retiring companies is not a way around that limit.
Part of Submission and status.
When you can call this
Only for a Sandbox company you created with your test key. Calling it again for a company you already retired returns 204 and changes nothing.
Errors
| Status | Meaning |
|---|---|
401 | The API key is missing, malformed or expired. |
404 | No Sandbox company with this ID belongs to your partner account. A Production company is not found with a test key, and a retired company is not found by any other request. |
409 | The company can't be retired: it is not a Sandbox company you created with a test key. |
The company is retired.