# Invite someone to the workspace by email

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

`POST /api/v1/public/workspaces/workspaceId/invitations`

- 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); up to 60 requests an hour per inviteLimiterKey.

Needs `workspace:members:invite` (and admin when the org limits invitations to admins). Refused with 402 `SEAT_LIMIT_REACHED` when seats are full, 403 `WORKSPACE_INVITES_DISABLED` or `USER_BLOCKED`, 409 when the person is already a member or invited, 502 `INVITATION_EMAIL_FAILED` when the mail cannot be queued (nothing is kept), and 503 when the org has no email sender.

## Request

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

Send the body as `application/json`.

| Field        | Type   | Required | Constraints    | Description |
| ------------ | ------ | -------- | -------------- | ----------- |
| `email`      | string | Yes      | format `email` | -           |
| `role`       | string | Yes      | -              | -           |
| `landingUrl` | string | No       | format `uri`   | -           |

## 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/invitations" \
  -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/invitations',
  {
    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/invitations",
    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"
{
  "_id": "000000000000000000000001",
  "clientId": "Ibu9DY7diz1Voakp3WtCJBJ88o3V6HxHyCXiZ3qn",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "deleted": false,
  "email": "user@example.com",
  "invitedAt": "2026-01-01T00:00:00.000Z",
  "invitedBy": "000000000000000000000002",
  "landingUrl": "http://localhost:9999/callback",
  "message": "Invitation sent to user@example.com",
  "resendAvailableAt": "2026-01-01T00:00:00.000Z",
  "role": "editor",
  "status": "invited",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "validTill": "2026-01-01T00:00:00.000Z",
  "workspace": "000000000000000000000003"
}
```

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