Send a password reset code by email
Always answers with the same generic message, whether or not an account exists.
POST/api/v1/auth/send-forgot-password-verification-code
- Sign-in
- No credential. Name the organization with the hosted sign-in state header or the org query parameter.
- 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.
Always answers with the same generic message, whether or not an account exists. For an existing, unblocked, non-agent account it stores a reset code and emails it, subject to the send quota.
Request
Send the body as application/json.
Body
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
email | string | Yes | format email | - |
Example request
Replace each YOUR_... value with your own.
curl -X POST "https://api.console.buildbase.app/api/v1/auth/send-forgot-password-verification-code?org=YOUR_ORG_ID" \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]"
}'const response = await fetch(
'https://api.console.buildbase.app/api/v1/auth/send-forgot-password-verification-code?org=YOUR_ORG_ID',
{
method: 'POST',
headers: {
'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 requests
response = requests.post(
"https://api.console.buildbase.app/api/v1/auth/send-forgot-password-verification-code?org=YOUR_ORG_ID",
json={
"email": "[email protected]",
},
timeout=30,
)
response.raise_for_status()
data = response.json()Responses
200 OK
OK
{
"message": "If an account exists for this email, a reset code has been sent.",
"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.
{
"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.
Unauthorized429 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
}Events
A successful call can send these webhook events to the endpoints that subscribe to them:
Related
- Auth guide: how this part of BuildBase works
- All Auth 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
auth.sendForgotPasswordVerificationCode.createin public-v1.json