Update workspace client group

PUT/v1/api/client-groups/{client_group_id}

Update or archive a workspace client group using OAuth agent access.

Scope
workspace:write
Token
OAuth access token only
Role
Editor, owner or admin
MCP tool
update_client_group · preview: MCP write tools are in preview
What scopes, tokens and roles mean →
Request
curl -X PUT "https://api.crawle.io/v1/api/client-groups/11111111-1111-1111-1111-111111111111" \
  -H "Authorization: Bearer $CRAWLE_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
const response = await fetch("https://api.crawle.io/v1/api/client-groups/11111111-1111-1111-1111-111111111111", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.CRAWLE_ACCESS_TOKEN}`,
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
const data = await response.json();
import os
import uuid

import requests

response = requests.request(
    "PUT",
    "https://api.crawle.io/v1/api/client-groups/11111111-1111-1111-1111-111111111111",
    headers={
        "Authorization": f"Bearer {os.environ['CRAWLE_ACCESS_TOKEN']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={},
)
data = response.json()
$CRAWLE_ACCESS_TOKEN
is an OAuth access token from your integration's sign-in.
Idempotency-Key
is a new unique value for each new request.

Response 200: a JSON object. Its fields are not described in the API contract yet, so no example is shown.

Parameters

client_group_idpath · string (uuid)required
Idempotency-Keyheader · stringrequired
1–180 characters

Request body

archivedboolean or null
colorstring or null
up to 24 characters
descriptionstring or null
up to 1000 characters
namestring or null
1–120 characters
settingsobject or null

Response 200

Returns a JSON object. Its fields are not described in the API contract yet.

Errors

  • 401

    When
    Missing, invalid, or expired token.
  • 403

    When
    The token has none of the accepted scopes (workspace:write).
  • 403

    When
    Called with an API key. This endpoint needs an OAuth access token.
  • 403

    When
    The person's workspace role is below editor.
  • 422

    When
    The request did not match the schema. detail lists each problem.
  • 429

    When
    Rate limited. Wait for Retry-After seconds.

All errors and what to do →

Generated from the API contract at 7e7039b0b, synced October 30, 2026.