Return a checked-out account

Frees it for the next test, and can record the state you left it in: tags to add (premium) and to remove (trial).

post/v1/addresses/{address}/return

Request

  • Base URL: https://api.proxymail.qa
  • URL: https://api.proxymail.qa/v1/addresses/{address}/return
  • Auth: HTTP bearer

Path parameters

addressstring email required

The test address, URL-encoded. A variant also works: capitals, or a +tag (k7f2x9ab12cd+o'brien@mailclub.dev). It acts on the plain address; waiting on a +tag variant, or listing its messages, only finds mail sent to that variant.

Request body

tokenstring uuid required
add_tagsstring[]
remove_tagsstring[]

Response

The account

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.