Remove a sign-up form
const url = 'https://api.proxymail.qa/v1/project/signup-forms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?remove_custom_fields=false';const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request DELETE \ --url 'https://api.proxymail.qa/v1/project/signup-forms/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?remove_custom_fields=false' \ --header 'Authorization: Bearer <token>'Removes it: whoever made it or a lead may. A request waiting for it is withdrawn. The custom fields it made stay, unless remove_custom_fields=true: then they go too, except any another form still uses. On a locked project only a lead removes them; otherwise whoever made one can. The answer names those removed and those kept.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Also remove the custom fields the form made.
Responses
Section titled “Responses”Removed
object
Requested: the project is locked, so a lead was asked.
object
Requested: a lead hasn’t answered yet; draft: asked for and never approved.
The form. Only name and screens are required.
object
What the form is called, such as Main sign-up.
The site it’s on, as the project lists it, such as https://staging.example.com/*. Leave out to match on every site.
The form’s language, for its default labels: en (the default), de, fr, es, it, pt, nl, zh or ja.
A two-letter country code for the fields that depend on one (IDs, VAT numbers, phones, addresses).
The screens in order, up to 10, with up to 60 fields in all.
object
The screen’s heading.
The page’s path, such as /signup.
A sign-up screen the project keeps, from list_sites.
The fields in order. Each section once in the form.
object
A section id from list_form_sections, such as email, password or business.team_size; or custom, with custom_field, for a question one of the project’s own custom fields answers.
Section custom only: the custom field that fills it, by its id from list_custom_fields. It keeps deciding the value; the form puts the field in its code, tests and preview. Give the field the test id or label that custom field looks for.
Defaults to true.
The field’s label; defaults to the section’s label in the form’s language. Needed for section custom.
Its data-testid; defaults to signup- and the section id with dashes, such as signup-business-team-size, or for section custom signup- and the label, such as signup-team-size.
Only what the section takes.
object
Section custom only: a text box, a drop-down (with choices) or a tick box. Defaults to select with choices, else text.
A two-letter country code, for a country-dependent section.
Password only.
Password only.
Password only: the kinds of character it must have.
Date of birth only: the youngest age the form accepts.
The options of a drop-down or radio group (gender, language, how someone heard, role, team size, or a section custom drop-down).
The custom fields the form needs.
object
The custom field to change.
Ignored here, and allowed so a custom field can be sent back as listed. PATCH this path to turn one on or off.
How to recognise the field: words its label or name contains (3 to 100 characters, or 2 in Chinese, Japanese or Korean), with up to 9 more phrases in also, such as its label in other languages; or its exact test ID, name or id attribute; or, for a ready-made custom field, kind with its section as text. Saving replaces the custom field, so send every phrase to keep.
object
Words only: more phrases that recognise the same field, such as its label in the site’s other languages.
Its host or a site pattern, such as staging.acme.dev or https://.acme.dev/, or null for every site. It needn’t be one of the project’s sites yet; a blocked site is refused.
A page path such as /signup. It covers /signup, /signup/business and the same page under a language, such as /de/signup. Leave it out, or send null, for every page of the site.
What goes in the field. text: { text }. template: { template } with {first_name}, {last_name}, {full_name}, {username}, {email}, {company}, {country} or {digits:N} (N from 1 to 12). option: { option }, the option to pick. list: { items }, 2 to 20, one picked for each account. options: { options }, 1 to 20, every one for every account: ticks the boxes of a group (matched by their shared name or words in the question they answer) or selects them in a drop-down that takes several answers, and boxes not listed are unticked, though a consent box, a marketing box or a box with its own custom field is left as it is. Never a radio group. checkbox: { checked }. generate: Proxy Mail QA makes up a value that suits the field (the same for the same account), on any field but a checkbox, never a personal ID field. leave: leave the field as it is. ready_made: { section }, matched on kind (or test_id when a sign-up form made it), Proxy Mail QA’s own safe value, where it has one: phone (a number set aside for fiction, or phones: the team’s own test number per country), id.national, id.tax, id.passport, business.vat and business.tax (a fake value only where one can never be a real person’s, or ids_from: a KYC vendor’s sandbox values), gender, referral_source, language, business.role, business.team_size and business.type (one of the field’s options) and consent.terms (ticked unless checked is false).
object
Checkbox, or ready_made consent.terms (true by default).
Ready_made only: the field catalogue section it fills.
Ready_made ID and tax numbers only: safe (the default) or a KYC vendor’s sandbox values.
Ready_made phone only: the team’s own test numbers, one per country, for accounts in countries with no numbers set aside for fiction. Never a real person’s number.
object
4 to 30 digits, spaces, brackets or dashes, with an optional leading +.
An option or one of a list only: tag the account with the answer.
How each field gets its value.
object
What a member asked the leads for, while a request waits.
object
The form. Only name and screens are required.
object
What the form is called, such as Main sign-up.
The site it’s on, as the project lists it, such as https://staging.example.com/*. Leave out to match on every site.
The form’s language, for its default labels: en (the default), de, fr, es, it, pt, nl, zh or ja.
A two-letter country code for the fields that depend on one (IDs, VAT numbers, phones, addresses).
The screens in order, up to 10, with up to 60 fields in all.
object
The screen’s heading.
The page’s path, such as /signup.
A sign-up screen the project keeps, from list_sites.
The fields in order. Each section once in the form.
object
A section id from list_form_sections, such as email, password or business.team_size; or custom, with custom_field, for a question one of the project’s own custom fields answers.
Section custom only: the custom field that fills it, by its id from list_custom_fields. It keeps deciding the value; the form puts the field in its code, tests and preview. Give the field the test id or label that custom field looks for.
Defaults to true.
The field’s label; defaults to the section’s label in the form’s language. Needed for section custom.
Its data-testid; defaults to signup- and the section id with dashes, such as signup-business-team-size, or for section custom signup- and the label, such as signup-team-size.
Only what the section takes.
object
Section custom only: a text box, a drop-down (with choices) or a tick box. Defaults to select with choices, else text.
A two-letter country code, for a country-dependent section.
Password only.
Password only.
Password only: the kinds of character it must have.
Date of birth only: the youngest age the form accepts.
The options of a drop-down or radio group (gender, language, how someone heard, role, team size, or a section custom drop-down).
object
The custom field to change.
Ignored here, and allowed so a custom field can be sent back as listed. PATCH this path to turn one on or off.
How to recognise the field: words its label or name contains (3 to 100 characters, or 2 in Chinese, Japanese or Korean), with up to 9 more phrases in also, such as its label in other languages; or its exact test ID, name or id attribute; or, for a ready-made custom field, kind with its section as text. Saving replaces the custom field, so send every phrase to keep.
object
Words only: more phrases that recognise the same field, such as its label in the site’s other languages.
Its host or a site pattern, such as staging.acme.dev or https://.acme.dev/, or null for every site. It needn’t be one of the project’s sites yet; a blocked site is refused.
A page path such as /signup. It covers /signup, /signup/business and the same page under a language, such as /de/signup. Leave it out, or send null, for every page of the site.
What goes in the field. text: { text }. template: { template } with {first_name}, {last_name}, {full_name}, {username}, {email}, {company}, {country} or {digits:N} (N from 1 to 12). option: { option }, the option to pick. list: { items }, 2 to 20, one picked for each account. options: { options }, 1 to 20, every one for every account: ticks the boxes of a group (matched by their shared name or words in the question they answer) or selects them in a drop-down that takes several answers, and boxes not listed are unticked, though a consent box, a marketing box or a box with its own custom field is left as it is. Never a radio group. checkbox: { checked }. generate: Proxy Mail QA makes up a value that suits the field (the same for the same account), on any field but a checkbox, never a personal ID field. leave: leave the field as it is. ready_made: { section }, matched on kind (or test_id when a sign-up form made it), Proxy Mail QA’s own safe value, where it has one: phone (a number set aside for fiction, or phones: the team’s own test number per country), id.national, id.tax, id.passport, business.vat and business.tax (a fake value only where one can never be a real person’s, or ids_from: a KYC vendor’s sandbox values), gender, referral_source, language, business.role, business.team_size and business.type (one of the field’s options) and consent.terms (ticked unless checked is false).
object
Checkbox, or ready_made consent.terms (true by default).
Ready_made only: the field catalogue section it fills.
Ready_made ID and tax numbers only: safe (the default) or a KYC vendor’s sandbox values.
Ready_made phone only: the team’s own test numbers, one per country, for accounts in countries with no numbers set aside for fiction. Never a real person’s number.
object
4 to 30 digits, spaces, brackets or dashes, with an optional leading +.
An option or one of a list only: tag the account with the answer.
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.
Saving: what fills each field a custom field fills. made: the save makes a ready-made one; form: a ready-made field a form made; yours: the project’s own. A field with section custom has named: true and finds: whether its custom field finds it on the page.
object
Saving: fields the project’s own custom field also fills, where the form’s ready-made field wins.
object
Saving: custom fields the form made and no longer uses (gone, renamed or yours).
object
Saving with tidy: the custom fields moved, removed, asked about and kept, by name.
object
The form removed.
Removing: the custom fields that went with it, by name.
Removing with remove_custom_fields on a locked project, for a key whose creator isn’t a lead: those the leads were asked to remove.
Removing with remove_custom_fields: those that stay, as someone else made them on an unlocked project, or a request to the leads couldn’t be sent (5 waiting, or a different request about it waiting).
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": "saved", "form": { "status": "saved", "created_via": "app", "spec": { "version": 1, "screens": [ { "fields": [ { "options": { "type": "text", "classes": [ "lower" ] } } ] } ] }, "custom_fields": [ { "name": "Company size", "match": { "on": "words" }, "site": "https://staging.acme.dev/*", "path": "/signup", "field_type": "text", "value": { "kind": "text", "section": "phone", "ids_from": "safe", "phones": [ { "country": "IN" } ] } } ], "fills": [ { "fill": "built_in" } ], "requested": { "spec": { "version": 1, "screens": [ { "fields": [ { "options": { "type": "text", "classes": [ "lower" ] } } ] } ] }, "custom_fields": [ { "name": "Company size", "match": { "on": "words" }, "site": "https://staging.acme.dev/*", "path": "/signup", "field_type": "text", "value": { "kind": "text", "section": "phone", "ids_from": "safe", "phones": [ { "country": "IN" } ] } } ] }, "request": { "kind": "save_custom_field", "status": "requested" } }, "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.
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.