SynterSynterDocs
View as Markdown
API Reference

Pause Campaign

Pause a campaign on a connected ad account

POSThttps://api.synterai.com/v1/campaigns/:id/pause

Write operation

This changes a live ad account. Pausing is a routine update: under the default workspace policy it runs immediately and is recorded in the audit log. There is no resume endpoint; turning a campaign back on is an enable, which the safety gate holds for approval under the default policy. See Approval model.

Path parameters

idstringrequired

Campaign ID from the ad platform (Amazon DSP: order ID)

Request body (optional)

platformstring

Defaults to GOOGLE. Also META, LINKEDIN, REDDIT, MICROSOFT, TIKTOK, X, AMAZON_DSP, SPOTIFY. On Meta, Reddit, Microsoft, TikTok, and X the pause also covers child ad sets or ad groups.

account_idstring

Ad account to use when the workspace has more than one connected account for the platform

Example request

bash
curl -X POST "https://api.synterai.com/v1/campaigns/1234567890/pause" \
  -H "Authorization: Bearer $SYNTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"platform": "GOOGLE"}'

Responses

  • 200: the script's JSON output with success: true and usage_cost_usd. Credits are charged only on success.
  • 202 APPROVAL_REQUIRED: the safety gate held (safety_gate_action: "pending") or refused ("block") the write. Nothing ran.
  • 400 NO_CREDENTIALS (platform not connected) or MISSING_CONFIGURATION; 401 bad key; 402 INSUFFICIENT_CREDITS; 403 missing scope; 502 PLATFORM_API_ERROR with the platform's message.

From an SDK, use campaigns.pause (Google Ads only). See the SDK pages.

Was this page helpful?
PreviousGet MetricsNext Update Budget