# Add or remove the people named in a group

Needs the groups area at manage, or being one of the group's managers.

`POST /api/v1/public/workspaces/workspaceId/enterprise/groups/groupId/members`

- 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 a minute per signedInWriteKey (some requests are not counted).

Needs the `groups` area at `manage`, or being one of the group's managers. A manager may not change a group that reaches a company role, nor add themselves or another manager (403); a role holder changing such a group needs a recent sign-in (403 `reauth_required`).

## Request

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

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

| Field    | Type            | Required | Constraints       | Description |
| -------- | --------------- | -------- | ----------------- | ----------- |
| `add`    | array of string | No       | at most 100 items | -           |
| `remove` | array of string | No       | at most 100 items | -           |

## 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/enterprise/groups/YOUR_GROUP_ID/members" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "add": [
    "string"
  ],
  "remove": [
    "string"
  ]
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/groups/YOUR_GROUP_ID/members',
  {
    method: 'POST',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      add: ['string'],
      remove: ['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/enterprise/groups/YOUR_GROUP_ID/members",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "add": [
            "string",
        ],
        "remove": [
            "string",
        ],
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "added": 1,
  "applied": 1,
  "group": {
    "companyRole": null,
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdVia": "console",
    "description": "",
    "groupId": "000000000000000000000001",
    "includedIn": [
      {
        "groupId": "000000000000000000000002",
        "name": "Engineering"
      }
    ],
    "includes": [],
    "inherited": [
      {
        "companyRole": null,
        "from": {
          "groupId": "000000000000000000000002",
          "name": "Engineering"
        },
        "workspaces": [
          {
            "role": "editor",
            "workspaceId": "000000000000000000000003",
            "workspaceName": "Globex design 1767225600000"
          }
        ]
      }
    ],
    "linked": [],
    "managers": [
      {
        "active": true,
        "addedAt": "2026-01-01T00:00:00.000Z",
        "addedVia": "app",
        "email": "user@example.com",
        "name": "mia Directory",
        "userId": "000000000000000000000004"
      },
      {
        "active": true,
        "addedAt": "2026-01-01T00:00:00.000Z",
        "addedVia": "app",
        "email": "user@example.com",
        "name": "Session User m23-managers-kai",
        "userId": "000000000000000000000005"
      }
    ],
    "members": [
      {
        "email": "user@example.com",
        "name": "Session User m23-managers-priya",
        "userId": "000000000000000000000006"
      },
      {
        "email": "user@example.com",
        "name": "Session User m23-managers-lena",
        "userId": "000000000000000000000007"
      }
    ],
    "name": "Backend",
    "people": 2,
    "peopleBy": {
      "included": 0,
      "linked": 0,
      "named": 2
    },
    "rolesReached": [],
    "workos": null,
    "workspaces": [
      {
        "role": "viewer",
        "workspaceId": "000000000000000000000008",
        "workspaceName": "Globex support 1767225600000"
      }
    ]
  },
  "pending": 0,
  "removed": 0
}
```

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

- [`enterprise.group_members_changed`](/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.enterprise.groups.members.create` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
