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.

post/v1/addresses/checkout

Request

  • Base URL: https://api.proxymail.qa
  • URL: https://api.proxymail.qa/v1/addresses/checkout
  • Auth: HTTP bearer

Headers

Proxy-Mail-QA-Runstring uuid

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.

Proxy-Mail-QA-Teststring

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

tagsstring[]

Every one of these tags.

countrystring

ISO 3166-1 alpha-2, such as DE.

min_ageinteger
max_ageinteger
has_passwordboolean
searchstring

Part of the address, label, notes, name or username.

sitestring

Used on this site: a host or page URL.

environmentstring

Used in this environment, such as staging.

minutesinteger

Response

The account, held for you

addressstring
labelstring nullable
created_atstring date-time
expires_atstring date-time
notesstring nullable
tagsstring[]
has_passwordboolean
passwordstring

Only in the response to creating it with password: true.

sitestring

Where it is used: the host of the app under test. Present only when set.

environmentstring

Which environment it is used in, such as staging. Present only when set.

email_countinteger
latestobject nullable

The newest code or link, like Match.

checked_out_untilstring date-time

Only while someone has it checked out of the pool.

Changes

No recorded changes to this operation across all 1 revision of this API.