Save a new test password

Saves the password the test account uses now, replacing the one saved under the same label: after the app under test changed or reset it. Leave password out to generate a strong one (16 characters), returned once in this response. Any key can save one; reading it back needs "Can read saved passwords". Every save is logged. Only for test accounts' passwords, never a real person's.

put/v1/addresses/{address}/password

Request

  • Base URL: https://api.proxymail.qa
  • URL: https://api.proxymail.qa/v1/addresses/{address}/password
  • 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

passwordstring

Left out, one is generated.

labelstring

Which saved secret, such as password or pin.

Response

Saved

addressstring
labelstring
savedboolean
passwordstring

Only when it was generated, shown this once.

Changes

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