Record a visitor's consent choices
Public, no session needed; a session or auth state, when present, files the record under the account.
POST/api/v1/public/orgId/consent
- 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 120 requests a minute per IP address.
Public, no session needed; a session or auth state, when present, files the record under the account. Rate limited per IP, sized for many visitors behind one address. Answers 429 when the org's daily ceiling is reached; a failed write answers recorded: false, not an error.
Request
Path parameters
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
orgId | string | Yes | - | - |
Send the body as application/json.
Body
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
clientId | string | Yes | 1 to 100 characters | - |
visitorId | string | Yes | matches ^[A-Za-z0-9_-]{16,64}$ | - |
choices | object | Yes | - | - |
choices.analytics | boolean | Yes | - | - |
choices.marketing | boolean | Yes | - | - |
manifestVersion | string | No | at most 64 characters | - |
consentString | string | No | at most 2000 characters | - |
source | string | No | matches ^[a-z0-9_:-]{1,40}$ | - |
Example request
Replace each YOUR_... value with your own.
curl -X POST "https://api.console.buildbase.app/api/v1/public/YOUR_ORG_ID/consent" \
-H "Content-Type: application/json" \
-d '{
"clientId": "YOUR_CLIENT_ID",
"visitorId": "YOUR_VISITOR_ID",
"choices": {
"analytics": true,
"marketing": true
}
}'const response = await fetch(
'https://api.console.buildbase.app/api/v1/public/YOUR_ORG_ID/consent',
{
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
clientId: 'YOUR_CLIENT_ID',
visitorId: 'YOUR_VISITOR_ID',
choices: {
analytics: true,
marketing: true,
},
}),
}
);
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/public/YOUR_ORG_ID/consent",
json={
"clientId": "YOUR_CLIENT_ID",
"visitorId": "YOUR_VISITOR_ID",
"choices": {
"analytics": True,
"marketing": True,
},
},
timeout=30,
)
response.raise_for_status()
data = response.json()Responses
200 OK
OK
{
"recorded": 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"
}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
- Consent guide: how this part of BuildBase works
- All Consent 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
consent.createin public-v1.json