Skip to content
BuildBase
HTTP API menu

Update a company group's name, people, workspaces or role

Needs the groups area at manage; a change that reaches a company role also needs a recent sign-in (403 reauth_required).

PATCH/api/v1/public/workspaces/workspaceId/enterprise/groups/groupId

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; a change that reaches a company role also needs a recent sign-in (403 reauth_required). 409 name_taken or a nesting cycle, 422 when nested too deep.

Request

Path parameters

FieldTypeRequiredConstraintsDescription
workspaceIdstringYes--
groupIdstringYes--

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

Body

FieldTypeRequiredConstraintsDescription
namestringNo1 to 60 characters-
descriptionstringNoat most 280 characters-
membersarray of stringNoat most 1000 items-
linkedarray of objectNoat most 6 items-
linked[].sourcestringNoone of "workos_role", "directory", "sso_role", "sso_group"-
linked[].groupIdstringNo1 to 200 characters-
linked[].groupNamestringNoat most 200 characters-
workspacesarray of objectNoat most 20 items-
workspaces[].workspaceIdstringNomatches ^[a-f0-9]{24}$-
workspaces[].rolestringNo1 to 64 characters-
companyRoleone of: string, nullNo--
assignableInWorkOSbooleanNo--
includesarray of stringNoat most 50 items-

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/workspaces/YOUR_WORKSPACE_ID/enterprise/groups/YOUR_GROUP_ID" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example",
  "description": "string",
  "members": [
    "string"
  ]
}'
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/groups/YOUR_GROUP_ID',
  {
    method: 'PATCH',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Example',
      description: 'string',
      members: ['string'],
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
import os

import requests

response = requests.patch(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/groups/YOUR_GROUP_ID",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "name": "Example",
        "description": "string",
        "members": [
            "string",
        ],
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()

Responses

200 OK

OK

Example
{
  "applied": 1,
  "group": {
    "companyRole": null,
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdVia": "app",
    "description": "",
    "groupId": "000000000000000000000001",
    "includedIn": [
      {
        "groupId": "000000000000000000000002",
        "name": "Engineering"
      }
    ],
    "includes": [
      {
        "groupId": "000000000000000000000003",
        "name": "On-call"
      }
    ],
    "inherited": [
      {
        "companyRole": null,
        "from": {
          "groupId": "000000000000000000000002",
          "name": "Engineering"
        },
        "workspaces": [
          {
            "role": "editor",
            "workspaceId": "000000000000000000000004",
            "workspaceName": "Globex design 1767225600000"
          }
        ]
      }
    ],
    "linked": [
      {
        "groupId": "directory_group_01STUB5AFD616E105DFD330795",
        "groupName": "backend-eng",
        "source": "directory"
      }
    ],
    "managers": [],
    "members": [
      {
        "email": "[email protected]",
        "name": "Session User m23-nested-priya",
        "userId": "000000000000000000000005"
      }
    ],
    "name": "Backend",
    "people": 3,
    "peopleBy": {
      "included": 1,
      "linked": 1,
      "named": 1
    },
    "rolesReached": [],
    "workos": null,
    "workspaces": [
      {
        "role": "viewer",
        "workspaceId": "000000000000000000000006",
        "workspaceName": "Globex support 1767225600000"
      }
    ]
  },
  "pending": 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.

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
}

Events

A successful call can send these webhook events to the endpoints that subscribe to them: