Create a test address

post/v1/addresses

Request

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

labelstring

What it is for, e.g. "Checkout test".

namestring

A custom name before the @: 3–64 lowercase letters, digits, dots (not first, last or doubled) or any of ! # $ % & ' * - / = ? ^ _ ` { | } ~. Random when left out.

personaboolean

Also generate a fictional first name, last name and username.

passwordboolean

Also generate a strong password for the sign-up form and save it on the address. It is returned once, in this response; reading it again needs a key with "Can read saved passwords".

lifetime_daysinteger

Defaults to the plan's maximum.

domainstring

One of the project's mail domains (GET /v1/project). Defaults to the project's.

age'adult' | 'over21' | 'under18' | 'under15' | 'under13' | 'any' | 'turns18tomorrow' | 'turned18today'

Give the persona a date of birth for this age: adult (18 to 65), over21, under18 (15 to 17), under15 (13 or 14), under13 (8 to 12), any (8 to 80), or someone who turns 18 tomorrow or turned 18 today. Leave out for no date of birth.

date_of_birthstring date

A date of birth to use instead of age, YYYY-MM-DD.

countrystring

Where the persona lives, as an ISO 3166-1 alpha-2 code such as GB or US (persona.country). Leave out for none.

sitestring

Where the account is used: the host or a page URL of the app under test, kept as the host.

environmentstring

Which environment of the app, such as staging, qa or local.

Response

The new address. With password: true, it also has password, shown this once.

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.