Skip to content
BuildBase
HTTP API menu

Start turning a guest into an account by emailing a code

Checks the address and the password, then emails a confirmation code to the address.

POST/api/v1/public/guest/upgrade

Sign-in
A signed-in user's session: send the session id in the x-session-id header.
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.

Checks the address and the password, then emails a confirmation code to the address. Answers 409 when the caller is not a guest or the address is unavailable, 429 during a cooldown or after too many codes for the address, and 503 when the code cannot be sent.

Request

Send the body as application/json.

Body

FieldTypeRequiredConstraintsDescription
emailstringYesformat email, at most 320 characters-
namestringNo1 to 200 characters-
passwordstringNo8 to 256 characters-

Example request

Replace each YOUR_... value with your own, and set the credential in the environment variable the sample reads.

curl -X POST "https://api.console.buildbase.app/api/v1/public/guest/upgrade" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "[email protected]"
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/guest/upgrade',
  {
    method: 'POST',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      email: '[email protected]',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
import os

import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/public/guest/upgrade",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "email": "[email protected]",
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()

Responses

200 OK

OK

Example
{
  "data": {
    "retryAfter": 30
  },
  "success": true
}

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.

Example
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}

401 Unauthorized

What it means: The credential is missing, expired or not accepted here, or the caller's role has no grant for x-permission (refused with 401 too). The body is the plain text Unauthorized, or a JSON body with a code where the gate says why.

What to do: Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

Example
Unauthorized

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.

Example
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}