Change its label, notes, tags or persona

Send only the fields to change; null or an empty string clears one. Use it when the app under test changed the first name, last name or username, so the saved persona still matches. To change the password, use PUT /v1/addresses/{address}/password.

patch/v1/addresses/{address}

Request

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

labelstring nullable
notesstring nullable
tagsstring[]
first_namestring nullable
last_namestring nullable
usernamestring nullable
date_of_birthstring date nullable

YYYY-MM-DD; null clears it.

countrystring nullable

ISO 3166-1 alpha-2 code such as GB; null clears it.

Response

The address

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.