API Reference

Pause Campaign

Pause a running campaign on any connected ad platform

POSThttps://api.syntermedia.ai/v1/campaigns/:id/pause

Write operation

This endpoint modifies your ad account. The campaign will stop running immediately. Use /v1/campaigns/:id/resume to restart.

Path parameters

idstringrequired

Campaign ID from the ad platform

Request body (optional)

reasonstring

Optional note for audit log

Example request

bash

curl -X POST "https://api.syntermedia.ai/v1/campaigns/123456789/pause" \
  -H "X-Synter-Key: syn_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"reason": "Budget exceeded for the month"}'

Example response

json

{
  "success": true,
  "campaign": {
    "id": "123456789",
    "platform": "GOOGLE",
    "name": "Brand - Search",
    "status": "PAUSED",
    "previous_status": "ENABLED"
  },
  "credits_used": 5
}

Error responses

404Campaign Not Found

The campaign ID does not exist or you don't have access

409Already Paused

The campaign is already paused

Was this page helpful?

PreviousGet Metrics Next Update Budget