Add, keep or name a sign-up screen
const url = 'https://api.proxymail.qa/v1/project/sites/screens';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"site":"staging.acme.dev","page":"/signup/team","screen":"Team details","label":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.proxymail.qa/v1/project/sites/screens \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "site": "staging.acme.dev", "page": "/signup/team", "screen": "Team details", "label": "example" }'Adds a page to a site’s sign-up screens (site and page), or a native app screen (screen, with site, or without it for the app screens), keeps one listed as suggested, or names it (label; empty removes the name). Send page or screen, not both. 201 when it’s new, 200 when it was already listed. On a locked project, a key whose creator isn’t a lead suggests it instead: it’s listed as suggested and the leads are asked to keep it (202). Up to 20 a site, and 20 app screens. Saving a screen doesn’t change multi_step.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
One of the project’s sites, by its host or pattern. Needed with page; leave it out for one of the app screens.
Example
staging.acme.devThe page’s path or address. Its query is left out; a path with an email address in it is refused. Don’t send one with an id or a token in it: it was made for one sign-up.
Example
/signup/teamA native app screen’s name.
Example
Team detailsA short name people recognise. Empty or null removes it; leave it out to keep the one it has.
Responses
Section titled “Responses”Already listed
object
Requested: the project is locked, so a lead was asked; a saved screen is listed as suggested until then.
One screen a site’s sign-up goes over: a page’s path, or a native app screen’s name.
object
Null for one of the app screens, which have no site.
The page’s path, or the native app screen’s name.
A short name people recognise.
Suggested: added by a fill or form-values, or waiting for a lead, and not kept yet.
Which screen of the sign-up it was, when known.
The sign-up screen removed.
A request to the project’s leads, who approve or decline it in Project settings. Who asked and answered, and when, are in the app.
object
The custom field, site, sign-up screen or sign-up form it changes, if any.
The custom field’s name, the site, the screen, or the setting’s new choice.
What it changes, as it applies once a lead approves it.
object
What the person who asked wrote for the leads.
A lead’s reason for declining.
Example
{ "status": "kept", "screen": { "kind": "path", "value": "/signup/team", "label": "Team details", "status": "kept", "origin": "added", "created_via": "app" }, "request": { "kind": "save_custom_field", "status": "requested" }}Added
object
Requested: the project is locked, so a lead was asked; a saved screen is listed as suggested until then.
One screen a site’s sign-up goes over: a page’s path, or a native app screen’s name.
object
Null for one of the app screens, which have no site.
The page’s path, or the native app screen’s name.
A short name people recognise.
Suggested: added by a fill or form-values, or waiting for a lead, and not kept yet.
Which screen of the sign-up it was, when known.
The sign-up screen removed.
A request to the project’s leads, who approve or decline it in Project settings. Who asked and answered, and when, are in the app.
object
The custom field, site, sign-up screen or sign-up form it changes, if any.
The custom field’s name, the site, the screen, or the setting’s new choice.
What it changes, as it applies once a lead approves it.
object
What the person who asked wrote for the leads.
A lead’s reason for declining.
Example
{ "status": "kept", "screen": { "kind": "path", "value": "/signup/team", "label": "Team details", "status": "kept", "origin": "added", "created_via": "app" }, "request": { "kind": "save_custom_field", "status": "requested" }}Asked a lead
object
Requested: the project is locked, so a lead was asked; a saved screen is listed as suggested until then.
One screen a site’s sign-up goes over: a page’s path, or a native app screen’s name.
object
Null for one of the app screens, which have no site.
The page’s path, or the native app screen’s name.
A short name people recognise.
Suggested: added by a fill or form-values, or waiting for a lead, and not kept yet.
Which screen of the sign-up it was, when known.
The sign-up screen removed.
A request to the project’s leads, who approve or decline it in Project settings. Who asked and answered, and when, are in the app.
object
The custom field, site, sign-up screen or sign-up form it changes, if any.
The custom field’s name, the site, the screen, or the setting’s new choice.
What it changes, as it applies once a lead approves it.
object
What the person who asked wrote for the leads.
A lead’s reason for declining.
Example
{ "status": "kept", "screen": { "kind": "path", "value": "/signup/team", "label": "Team details", "status": "kept", "origin": "added", "created_via": "app" }, "request": { "kind": "save_custom_field", "status": "requested" }}An error
object
What went wrong, as a code, such as bad_request (400), unauthorized (401), plan_required (402), forbidden (403), not_found (404), method_not_allowed (405), conflict (409), content_too_large (413), rate_limited, daily_limit or account_held (429), or server_error (500).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}No API key, or one that isn’t valid: it may have been revoked, or its creator no longer has access to the project.
object
What went wrong, as a code, such as bad_request (400), unauthorized (401), plan_required (402), forbidden (403), not_found (404), method_not_allowed (405), conflict (409), content_too_large (413), rate_limited, daily_limit or account_held (429), or server_error (500).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}Headers
Section titled “Headers”Bearer realm="proxymail-qa", with error="invalid_token" when a key was sent but isn’t valid.
An error
object
What went wrong, as a code, such as bad_request (400), unauthorized (401), plan_required (402), forbidden (403), not_found (404), method_not_allowed (405), conflict (409), content_too_large (413), rate_limited, daily_limit or account_held (429), or server_error (500).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}An error
object
What went wrong, as a code, such as bad_request (400), unauthorized (401), plan_required (402), forbidden (403), not_found (404), method_not_allowed (405), conflict (409), content_too_large (413), rate_limited, daily_limit or account_held (429), or server_error (500).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}The path doesn’t take this method.
object
What went wrong, as a code, such as bad_request (400), unauthorized (401), plan_required (402), forbidden (403), not_found (404), method_not_allowed (405), conflict (409), content_too_large (413), rate_limited, daily_limit or account_held (429), or server_error (500).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}Headers
Section titled “Headers”The methods it takes, such as GET, PATCH.
The request body is over 64 KB, or 256 KB for POST /v1/form-values.
object
What went wrong, as a code, such as bad_request (400), unauthorized (401), plan_required (402), forbidden (403), not_found (404), method_not_allowed (405), conflict (409), content_too_large (413), rate_limited, daily_limit or account_held (429), or server_error (500).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}Too many requests. With a Retry-After header, a per-minute limit was reached: the key’s requests (60 a minute on Free, 600 on Team), password reveals (30 a minute per person), or keys that aren’t valid from one network (120 a minute). Without one, error says which longer limit: daily_limit, the space’s new addresses for today (50 on Free), until midnight UTC; account_held, 10 addresses a day while a Free account’s recent use is looked at; or rate_limited when something is full, such as a project’s 50 custom fields.
object
What went wrong, as a code, such as bad_request (400), unauthorized (401), plan_required (402), forbidden (403), not_found (404), method_not_allowed (405), conflict (409), content_too_large (413), rate_limited, daily_limit or account_held (429), or server_error (500).
What went wrong and what to do, in words.
Example generated
{ "error": "example", "message": "example"}Headers
Section titled “Headers”Seconds to wait before trying again. Sent with per-minute limits only.