# Update one of the workspace's affiliate programs

Needs workspace:selling:manage.

> **Note:**

**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/workspaces/workspaceId/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).

Needs `workspace:selling:manage`. A partial change to the rate, tiers or levels is checked together with the stored values.

## Request

| Field         | Type   | Required | Constraints              | Description |
| ------------- | ------ | -------- | ------------------------ | ----------- |
| `workspaceId` | string | Yes      | -                        | -           |
| `id`          | string | Yes      | matches `^[a-f0-9]{24}$` | -           |

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

| Field                 | Type             | Required | Constraints                                                                    | Description |
| --------------------- | ---------------- | -------- | ------------------------------------------------------------------------------ | ----------- |
| `name`                | string           | No       | 1 to 100 characters                                                            | -           |
| `description`         | string or null   | No       | at most 1000 characters                                                        | -           |
| `kind`                | string           | No       | one of `"percent"`, `"fixed"`                                                  | -           |
| `percentBps`          | integer or null  | No       | at least 1, at most 10000                                                      | -           |
| `fixedAmount`         | integer or null  | No       | at least 1, at most 99999999                                                   | -           |
| `currency`            | string or null   | No       | matches `^[a-zA-Z]{3}$`                                                        | -           |
| `recurrence`          | string           | No       | one of `"first"`, `"all"`, `"count"`                                           | -           |
| `recurringPayments`   | integer or null  | No       | at least 1, at most 36                                                         | -           |
| `windowDays`          | integer          | No       | at least 1, at most 365                                                        | -           |
| `holdDays`            | integer          | No       | at least 0, at most 120                                                        | -           |
| `join`                | string           | No       | one of `"open"`, `"approval"`, `"invite"`                                      | -           |
| `payoutMethod`        | string           | No       | one of `"transfer"`, `"manual"`, `"paypal"`, `"wise_export"`                   | -           |
| `minPayout`           | integer or null  | No       | at least 0, at most 99999999                                                   | -           |
| `itemIds`             | array of string  | No       | at most 50 items                                                               | -           |
| `active`              | boolean          | No       | -                                                                              | -           |
| `payoutMethods`       | array of string  | No       | at least 1 items, at most 4 items                                              | -           |
| `tiers`               | array of object  | No       | at most 5 items                                                                | -           |
| `tiers[].threshold`   | integer          | No       | at least 1, at most 999999999                                                  | -           |
| `tiers[].percentBps`  | integer or null  | No       | at least 1, at most 10000                                                      | -           |
| `tiers[].fixedAmount` | integer or null  | No       | at least 1, at most 99999999                                                   | -           |
| `tierMetric`          | string           | No       | one of `"paid_referrals"`, `"revenue"`                                         | -           |
| `tierCurrency`        | string or null   | No       | matches `^[a-zA-Z]{3}$`                                                        | -           |
| `tierPeriod`          | string           | No       | one of `"lifetime"`, `"calendar_month"`, `"calendar_quarter"`, `"rolling_30d"` | -           |
| `tierApply`           | string           | No       | one of `"forward"`, `"retroactive"`                                            | -           |
| `codeAttribution`     | string           | No       | one of `"coupon_wins"`, `"link_wins"`                                          | -           |
| `couponRateBps`       | integer or null  | No       | at least 1, at most 10000                                                      | -           |
| `codeOnlyAttribution` | boolean          | No       | -                                                                              | -           |
| `levels`              | integer          | No       | at least 0, at most 2                                                          | -           |
| `levelBps`            | array of integer | No       | at most 2 items                                                                | -           |
| `levelBasis`          | string           | No       | one of `"commission"`, `"net"`                                                 | -           |
| `levelsAcknowledged`  | boolean          | No       | -                                                                              | -           |

## Example request

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

```bash title="cURL"
curl -X PATCH "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/affiliate-programs/YOUR_ID" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example",
  "description": "string",
  "kind": "percent"
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/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();
```

```python title="Python"
import os

import requests

response = requests.patch(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/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.

```json title="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.

```text title="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.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [Workspaces guide](/workspaces/overview): how this part of BuildBase works
- [All Workspaces operations](/http-api/reference/workspaces)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `workspaces.affiliatePrograms.update` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
