Join an organization's waitlist
Public.
POST/api/v1/beta/submit
- Sign-in
- None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
- Rate limit
- Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 10 requests a minute per IP address.
Public. The name is at most 200 characters, the email 254, and timezone, language, country and currency 64 each; a longer one answers 400. Every address, new, already listed or blocklisted, gets the same thank-you answer; a new address is stored as a pending entry and the waitlist's pending email is queued when the organization has switched it on and chosen a template. Answers 429 past the per-IP signup budget or when the waitlist is at its plan ceiling.
Request
Send the body as application/json.
Body
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
orgId | string | Yes | format tenantKey | - |
formData | object | Yes | - | - |
formData.name | string | Yes | 2 to 200 characters | - |
formData.email | string | Yes | format email, at most 254 characters | - |
formData.timezone | string | No | at most 64 characters | - |
formData.language | string | No | at most 64 characters | - |
formData.country | string | No | at most 64 characters | - |
formData.currency | string | No | at most 64 characters | - |
Example request
Replace each YOUR_... value with your own.
curl -X POST "https://api.console.buildbase.app/api/v1/beta/submit" \
-H "Content-Type: application/json" \
-d '{
"orgId": "YOUR_ORG_ID",
"formData": {
"name": "Example",
"email": "[email protected]"
}
}'const response = await fetch(
'https://api.console.buildbase.app/api/v1/beta/submit',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
orgId: 'YOUR_ORG_ID',
formData: {
name: 'Example',
email: '[email protected]',
},
}),
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();import requests
response = requests.post(
"https://api.console.buildbase.app/api/v1/beta/submit",
json={
"orgId": "YOUR_ORG_ID",
"formData": {
"name": "Example",
"email": "[email protected]",
},
},
timeout=30,
)
response.raise_for_status()
data = response.json()Responses
200 OK
OK
{
"code": "[REDACTED]",
"config": {
"approvalEmail": false,
"description": "Signup for beta access to the application",
"enabled": true,
"logoFallBack": "",
"name": "Beta Users",
"privacyPolicy": "",
"screen": {
"register": {
"description": "Register with your email for beta access",
"title": "Register to Beta Users"
},
"thankYou": {
"description": "You have successfully registered for beta access.",
"title": "Thank You for Registering"
}
},
"termsOfService": ""
},
"data": null,
"message": "You have successfully registered for beta access.",
"status": "success"
}Any other status
Any other answer the handler sends itself (its own refusals). Not described yet.
Errors
Each refusal, what it means, and what to do. The request changed nothing.
400 Bad Request
What it means: The request failed a validate() schema, or an id in the path is not a valid id. path names the field.
What to do: Fix the field the body names in path (or read message) and send the request again. Nothing was changed.
{
"error": true,
"success": false,
"path": "string",
"message": "string"
}404 Not Found
What it means: An id in the path names nothing in this org.
What to do: Check the ids in the path: one of them names nothing in this organization.
{
"success": false,
"message": "string"
}429 Too Many Requests
What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.
What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.
{
"success": false,
"message": "string",
"reason": "rate_limited",
"retryAfter": 1
}Related
- All Beta operations
- API reference: every operation, by tag
- Sign-in and credentials for the HTTP API
- How the HTTP API reports errors
- Make your first call
- Error codes: every
codethe API returns - OpenAPI: operation
beta.submit.createin public-v1.json