Skip to content
X-Buddy
Tiếng Việt

API reference

Add / remove accounts of a group

account_group_set_members — Add and/or remove accounts, or replace the whole member set (set).

Markdown version

account_group_set_members · Changes an X-Buddy setting

Add and/or remove accounts, or replace the whole member set (set). An account may sit in many groups. expected_revision required.
REST POST /api/public/v1/groups/{group_id}/members
MCP tool account_group_set_members
Permission needed accounts.run — Owner, Manager, Operator
Scope group automation:write
Group X account groups
Shown up front in profiles Automation, Infrastructure

Input

Field Type Required Description
group_id string (uuid) Yes Group id.
add array of string (1–100 chars) (0–200 items) No
remove array of string (1–100 chars) (0–200 items) No
set array of string (1–100 chars) (0–200 items) No Replace every member with exactly these accounts.
expected_revision integer (1–∞) Yes The revision you read (optimistic locking); a newer revision fails with revision_conflict.

Result

Returns the operation's result in the { data, meta } envelope.

Needs an idempotency key (Idempotency-Key, 8–128 characters). Retrying with the same key never repeats the action.

Versioned setting: send the expected_revision (or If-Match) you read, or the write is refused.

Example

Call over REST

curl -X POST "https://reach-link-craft.lovable.app/api/public/v1/groups/00000000-0000-4000-8000-000000000001/members" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Idempotency-Key: 6f1c2a90-example-key" \
  -H 'If-Match: "3"' \
  -H "Content-Type: application/json" \
  -d '{"expected_revision":1}'

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "account_group_set_members",
    "arguments": {
      "group_id": "00000000-0000-4000-8000-000000000001",
      "expected_revision": 1,
      "idempotency_key": "6f1c2a90-example-key"
    }
  }
}

Errors you may get

Code HTTP Retryable
unauthorized 401 No
key_expired 401 No
integration_revoked 401 No
connection_not_linked 403 No
integration_paused 403 No
workspace_integrations_paused 403 No
integration_authorization_lost 403 No
workspace_suspended 403 No
forbidden 403 No
invalid_input 422 No
rate_limited 429 Yes
internal 500 Yes
read_only 403 No
idempotency_key_required 428 No
idempotency_conflict 409 No
idempotency_processing 409 Yes
conflict 409 No
precondition_failed 422 No
revision_required 428 No
revision_conflict 412 No
not_found 404 No

Back to all operations