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

API reference

Apply a playbook to many accounts

playbook_apply_bulk — Copy a playbook's tasks onto every selected account (replacing earlier copies of it).

Markdown version

playbook_apply_bulk · Changes an X-Buddy setting

Copy a playbook's tasks onto every selected account (replacing earlier copies of it). Paused accounts are skipped. One result row per account: ok · refused · conflict · skipped. Growth tasks arrive OFF. dry_run shows the table without writing.
REST POST /api/public/v1/bulk/playbook-apply
MCP tool playbook_apply_bulk
Permission needed tasks.manage — Owner, Manager, Operator
Scope group automation:write
Group Tasks and playbooks
Shown up front in profiles Automation

Input

Field Type Required Description
playbook_id string (uuid) Yes Playbook id.
selector object Yes Which accounts: the union of account_ids and the members of group_ids. Empty = no account (never all).
dry_run boolean No true = return the per-account result table without changing anything.

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.

Example

Call over REST

curl -X POST "https://reach-link-craft.lovable.app/api/public/v1/bulk/playbook-apply" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Idempotency-Key: 6f1c2a90-example-key" \
  -H "Content-Type: application/json" \
  -d '{"playbook_id":"00000000-0000-4000-8000-000000000001","selector":{}}'

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "playbook_apply_bulk",
    "arguments": {
      "playbook_id": "00000000-0000-4000-8000-000000000001",
      "selector": {},
      "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
not_found 404 No

Back to all operations