Check out an account from the pool
An account in the project that matches every filter given, that nobody else has checked out, and that lives past the hold: the least recently used first. It's yours for minutes (default 10, at most 60): nobody else can check it out until you return it or the time runs out, which frees it on its own. Use the checkout.token to extend or return it. 409 when every matching account is checked out (saying when the first comes free), 404 when none match. Tag accounts with their state (verified, premium…) to make pools.
Request
- Base URL: https://api.proxymail.qa
- URL: https://api.proxymail.qa/v1/addresses/checkout
- Auth: HTTP bearer
Headers
A run's id (POST /v1/runs): adds what this call saw to the run. If it can't be added (the run finished, or isn't in this project), the call still works and the Proxy-Mail-QA-Run-Warning response header says why.
With Proxy-Mail-QA-Run: the test this call belongs to, percent-encoded (encodeURIComponent), up to 200 characters once decoded. The run's report shows it beside what the call saw.
Request body
Response
The account, held for you
Changes
No recorded changes to this operation across all 1 revision of this API.