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

API reference

Start / pause / stop a campaign

campaign_set_status — Start (or resume), pause, or stop a campaign.

Markdown version

campaign_set_status · Changes an X-Buddy setting

Start (or resume), pause, or stop a campaign. Stop ends it for good: people in it stop at their current step.
REST POST /api/public/v1/campaigns/{campaign_id}/status
MCP tool campaign_set_status
Permission needed campaigns.manage — Owner, Manager, Operator
Scope group automation:activate
Group Campaigns
Shown up front in profiles Automation

Input

Field Type Required Description
campaign_id string (uuid) Yes Campaign id.
status running · paused · stopped Yes

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/campaigns/00000000-0000-4000-8000-000000000001/status" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Idempotency-Key: 6f1c2a90-example-key" \
  -H "Content-Type: application/json" \
  -d '{"status":"running"}'

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "campaign_set_status",
    "arguments": {
      "campaign_id": "00000000-0000-4000-8000-000000000001",
      "status": "running",
      "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