# Add a user to the workspace by email, or invite them

Needs workspace:members:invite (and admin when the org limits invitations to admins).

`POST /api/v1/public/workspaces/workspaceId/users/add`

- 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:members:invite` (and admin when the org limits invitations to admins). When the org's workspace settings say `directAdd: "invite"` (the default for an org created since 13 November 2026), it adds at once (200) someone who already shares a workspace with the caller, or any account when the session was opened by the app's team; anyone else, and an address with no account, is sent the invitation `workspaces.invitations.create` sends and joins when they accept: 202 with `invited: true` and the `invitation`, the same answer whether or not the address has an account. With `directAdd: "instant"` (an org created before), an existing account is added at once and an address with no account answers 404. Answers 409 when already a member, 402 `SEAT_LIMIT_REACHED` when seats or the org's member limit are full, 403 when inviting is disabled or the role is above the caller's, and, for an invitation, the refusals `workspaces.invitations.create` gives.

## Request

| Field         | Type   | Required | Constraints | Description |
| ------------- | ------ | -------- | ----------- | ----------- |
| `workspaceId` | string | Yes      | -           | -           |

Send the body as `application/json`.

| Field   | Type   | Required | Constraints | Description |
| ------- | ------ | -------- | ----------- | ----------- |
| `email` | string | Yes      | -           | -           |
| `role`  | string | Yes      | -           | -           |

## 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 POST "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/users/add" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "user@example.com",
  "role": "string"
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/users/add',
  {
    method: 'POST',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      email: 'user@example.com',
      role: 'string',
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import os

import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/users/add",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "email": "user@example.com",
        "role": "string",
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "message": "Workspace user added successfully",
  "userId": "000000000000000000000001",
  "workspace": {
    "_id": "000000000000000000000002",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdBy": {
      "_id": "000000000000000000000003",
      "email": "user@example.com",
      "image": "",
      "name": "Session User m13-owner"
    },
    "creditBalance": 0,
    "deleted": false,
    "entitlement": {
      "decidedBy": {
        "sso-1794380633736": "default"
      },
      "features": {
        "sso-1794380633736": false
      },
      "grants": [],
      "limits": {},
      "planSlug": null,
      "quotas": {},
      "standing": "none",
      "subject": {
        "id": "000000000000000000000002",
        "type": "workspace"
      }
    },
    "features": {
      "sso-1794380633736": false
    },
    "id": "000000000000000000000002",
    "image": "",
    "limits": {},
    "memberCount": 8,
    "name": "Joining 1767225600000",
    "quotas": {
      "email_sends": {
        "allowOverage": false,
        "consumed": true,
        "included": 0,
        "limits": 0,
        "remaining": 0,
        "used": 0
      }
    },
    "roles": ["admin", "editor", "viewer"],
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "users": [
      {
        "_id": "000000000000000000000003",
        "email": "user@example.com",
        "image": "",
        "name": "Session User m13-owner",
        "role": "admin"
      },
      {
        "_id": "000000000000000000000004",
        "email": "user@example.com",
        "image": "",
        "name": "Session User m13-outsider",
        "role": "viewer"
      },
      {
        "_id": "000000000000000000000005",
        "email": "user@example.com",
        "image": "",
        "name": "Session User m13-early",
        "role": "viewer"
      },
      {
        "_id": "000000000000000000000006",
        "email": "user@example.com",
        "image": "",
        "name": "Session User m13-joiner",
        "role": "viewer"
      },
      {
        "_id": "000000000000000000000007",
        "email": "user@example.com",
        "image": "",
        "name": "Session User m13-asker",
        "role": "viewer"
      },
      {
        "_id": "000000000000000000000008",
        "email": "user@example.com",
        "image": "",
        "name": "Session User m13-late",
        "role": "viewer"
      },
      {
        "_id": "000000000000000000000009",
        "email": "user@example.com",
        "image": "",
        "name": "Session User m13-guest",
        "role": "viewer"
      },
      {
        "_id": "000000000000000000000001",
        "email": "user@example.com",
        "image": "",
        "name": "Session User m13-lead",
        "role": "admin"
      }
    ],
    "workflowsDisabled": false,
    "workspaceId": "P1xdNFhfjpnFUkw"
  }
}
```

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

```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
}
```

## Events

A successful call can send these [webhook events](/webhooks/overview) to the endpoints that subscribe to them:

- [`workspace.member_added`](/webhooks/overview#when-each-event-fires)
- [`workspace.member_invited`](/webhooks/overview#when-each-event-fires)

## 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.users.add.create` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
