Create a coupon for the workspace's items
Needs workspace:selling:manage.
Warning
Not fully described yet. The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.
POST/api/v1/public/workspaces/workspaceId/coupons
- 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).
Needs workspace:selling:manage. Invalid terms answer 422 COUPON_INVALID; a code another coupon has answers 409 COUPON_CODE_TAKEN.
Request
Path parameters
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
workspaceId | string | Yes | - | - |
Send the body as application/json.
Body
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
code | string | Yes | 3 to 32 characters | - |
kind | string | Yes | one of "percent", "amount" | - |
percentBps | integer or null | No | at least 1, at most 10000 | - |
amount | integer or null | No | at least 1, at most 99999999 | - |
currency | string or null | No | matches ^[a-zA-Z]{3}$ | - |
duration | string | No | one of "once", "repeating", "forever" | - |
durationPeriods | integer or null | No | at least 1, at most 36 | - |
maxRedemptions | integer or null | No | at least 1, at most 1000000 | - |
perBuyerOnce | boolean | No | - | - |
startsAt | string or null | No | at most 40 characters | - |
endsAt | string or null | No | at most 40 characters | - |
minSubtotal | integer or null | No | at least 0, at most 99999999 | - |
itemIds | array of string | No | at most 50 items | - |
active | boolean | No | - | - |
note | string or null | No | at most 200 characters | - |
affiliateId | string or null | No | matches ^[a-f0-9]{24}$ | - |
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/workspaces/YOUR_WORKSPACE_ID/coupons" \
-H "x-session-id: $BUILDBASE_SESSION_ID" \
-H "Content-Type: application/json" \
-d '{
"code": "string",
"kind": "percent"
}'const response = await fetch(
'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/coupons',
{
method: 'POST',
headers: {
'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
'Content-Type': 'application/json',
},
body: JSON.stringify({
code: 'string',
kind: 'percent',
}),
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();import os
import requests
response = requests.post(
"https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/coupons",
headers={
"x-session-id": os.environ["BUILDBASE_SESSION_ID"],
},
json={
"code": "string",
"kind": "percent",
},
timeout=30,
)
response.raise_for_status()
data = response.textResponses
A successful answer is not described yet. The server answers with the status and body its handler sends.
Any other status
The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).
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
}Related
- Workspaces guide: how this part of BuildBase works
- All Workspaces 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
workspaces.coupons.createin public-v1.json