Save a new test password

PUT

/v1/addresses/{address}/password

curl --request PUT \
  --url https://api.proxymail.qa/v1/addresses/k7f2x9ab12cd%40mailclub.dev/password \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "password": "example", "label": "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.

Authorizations

• apiKey

Parameters

Path Parameters

address

required

string format: email

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.

Example

k7f2x9ab12cd@mailclub.dev

Request Body

Media typeapplication/json

object

password

Left out, one is generated.

string

>= 1 characters <= 500 characters

label

Which saved secret, such as password or pin.

string

default: password

Responses

200

Saved

Media typeapplication/json

object

address

string

label

string

saved

boolean

password

Only when it was generated, shown this once.

string

Example ^generated

{
  "address": "example",
  "label": "example",
  "saved": true,
  "password": "example"
}

400

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

404

An error

Media typeapplication/json

object

error

string

message

string

Example ^generated

{
  "error": "example",
  "message": "example"
}