Skip to content
GET
/v1/signup-starters
curl --request GET \
--url 'https://api.proxymail.qa/v1/signup-starters?id=b2c&language=en' \
--header 'Authorization: Bearer <token>'

Specs to build a sign-up form from: b2c, b2b, education, marketplace, travel, fintech, japan and china, each with a description, notes and its spec, made of the field catalogue’s sections. Change one and save it with POST /v1/project/signup-forms. See https://proxymail.qa/docs/signup-forms#starters.

id
string
Allowed values: b2c b2b education marketplace travel fintech japan china

One starter.

language
string
Allowed values: en de fr es it pt nl zh ja

The form’s language: its labels and drop-downs.

country
string
/^[A-Za-z]{2}$/

The form’s country, for ID and phone formats.

The starters

Media typeapplication/json
object
starters
Array<object>
object
id
string
item

The plan’s row, such as FM-26.

string
name
string
description
string
notes
Array<string>
spec

A sign-up form spec, as POST /v1/project/signup-forms takes.

object

Example generated

{
"starters": [
{
"id": "example",
"item": "example",
"name": "example",
"description": "example",
"notes": [
"example"
],
"spec": {}
}
]
}

An error

Media typeapplication/json
object
error

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).

string
message

What went wrong and what to do, in words.

string

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.

Media typeapplication/json
object
error

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).

string
message

What went wrong and what to do, in words.

string

Example generated

{
"error": "example",
"message": "example"
}
WWW-Authenticate
string

Bearer realm="proxymail-qa", with error="invalid_token" when a key was sent but isn’t valid.

The path doesn’t take this method.

Media typeapplication/json
object
error

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).

string
message

What went wrong and what to do, in words.

string

Example generated

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

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.

Media typeapplication/json
object
error

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).

string
message

What went wrong and what to do, in words.

string

Example generated

{
"error": "example",
"message": "example"
}
Retry-After
integer
>= 1

Seconds to wait before trying again. Sent with per-minute limits only.