Skip to content
BuildBase
HTTP API menu

Update the terms of one of the signed-in seller's affiliate programs

Changes the fields sent and checks them together with the stored terms.

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.

PATCH/api/v1/public/me/affiliate-programs/id

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).

Changes the fields sent and checks them together with the stored terms. Refused with 422 when the resulting terms are invalid or PayPal payouts are not open on the platform. Another seller's program reads as not found.

Request

Path parameters

FieldTypeRequiredConstraintsDescription
idstringYesmatches ^[a-f0-9]{24}$-

Send the body as application/json. The body is optional.

Body

FieldTypeRequiredConstraintsDescription
namestringNo1 to 100 characters-
descriptionstring or nullNoat most 1000 characters-
kindstringNoone of "percent", "fixed"-
percentBpsinteger or nullNoat least 1, at most 10000-
fixedAmountinteger or nullNoat least 1, at most 99999999-
currencystring or nullNomatches ^[a-zA-Z]{3}$-
recurrencestringNoone of "first", "all", "count"-
recurringPaymentsinteger or nullNoat least 1, at most 36-
windowDaysintegerNoat least 1, at most 365-
holdDaysintegerNoat least 0, at most 120-
joinstringNoone of "open", "approval", "invite"-
payoutMethodstringNoone of "transfer", "manual", "paypal", "wise_export"-
minPayoutinteger or nullNoat least 0, at most 99999999-
itemIdsarray of stringNoat most 50 items-
activebooleanNo--
payoutMethodsarray of stringNoat least 1 items, at most 4 items-
tiersarray of objectNoat most 5 items-
tiers[].thresholdintegerNoat least 1, at most 999999999-
tiers[].percentBpsinteger or nullNoat least 1, at most 10000-
tiers[].fixedAmountinteger or nullNoat least 1, at most 99999999-
tierMetricstringNoone of "paid_referrals", "revenue"-
tierCurrencystring or nullNomatches ^[a-zA-Z]{3}$-
tierPeriodstringNoone of "lifetime", "calendar_month", "calendar_quarter", "rolling_30d"-
tierApplystringNoone of "forward", "retroactive"-
codeAttributionstringNoone of "coupon_wins", "link_wins"-
couponRateBpsinteger or nullNoat least 1, at most 10000-
codeOnlyAttributionbooleanNo--
levelsintegerNoat least 0, at most 2-
levelBpsarray of integerNoat most 2 items-
levelBasisstringNoone of "commission", "net"-
levelsAcknowledgedbooleanNo--

Example request

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

curl -X PATCH "https://api.console.buildbase.app/api/v1/public/me/affiliate-programs/YOUR_ID" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example",
  "description": "string",
  "kind": "percent"
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/me/affiliate-programs/YOUR_ID',
  {
    method: 'PATCH',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Example',
      description: '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.patch(
    "https://api.console.buildbase.app/api/v1/public/me/affiliate-programs/YOUR_ID",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "name": "Example",
        "description": "string",
        "kind": "percent",
    },
    timeout=30,
)
response.raise_for_status()
data = response.text

Responses

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.

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
}