Skip to main content
PATCH
/
api
/
v1
/
campaigns
/
live
/
{customer_id}
/
{campaign_id}
Patch Live Campaign Settings
curl --request PATCH \
  --url http://localhost:8000/api/v1/campaigns/live/{customer_id}/{campaign_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaign_name": "<string>",
  "status": "ENABLED",
  "daily_budget_micros": 123,
  "bidding_strategy": {
    "type": "MAXIMIZE_CONVERSIONS",
    "target_cpa_micros": 123,
    "target_roas": 1,
    "max_cpc_bid_ceiling_micros": 123
  },
  "network_settings": {
    "target_google_search": true,
    "target_search_network": false,
    "target_content_network": false
  },
  "language_ids": [
    123
  ],
  "location_targets": [
    {
      "geo_target_constant_id": 123,
      "target_type": "INCLUDE"
    }
  ],
  "ad_schedule": {
    "mode": "ALL_TIME",
    "schedule_entries": [
      {
        "day_of_week": "MONDAY",
        "start_hour": 11,
        "end_hour": 12,
        "start_minute": 0,
        "end_minute": 0
      }
    ]
  },
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "conversion_goals": [
    {
      "goal_type": "CAMPAIGN_SPECIFIC",
      "conversion_action_id": 1,
      "category": "PURCHASE"
    }
  ]
}
'
{
  "success": true,
  "campaign_updated": false,
  "budget_updated": false,
  "targeting_updated": false,
  "conversion_goals_updated": false,
  "warnings": [
    "<string>"
  ],
  "errors": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

customer_id
integer
required
campaign_id
integer
required

Query Parameters

token_id
integer | null

Optional specific Token ID

Body

application/json

Request schema for updating live campaign settings. All fields optional.

campaign_name
string | null
Required string length: 1 - 256
status
enum<string> | null
Available options:
ENABLED,
PAUSED
daily_budget_micros
integer | null
bidding_strategy
BiddingStrategySchema · object

Bidding strategy configuration.

network_settings
NetworkSettingsSchema · object

Network settings for campaign.

language_ids
integer[] | null
location_targets
LocationTargetSchema · object[] | null
ad_schedule
AdScheduleSchema · object

Ad schedule configuration.

start_date
string<date> | null
end_date
string<date> | null
conversion_goals
ConversionGoalSchema · object[] | null

Response

Successful Response

Response schema for campaign settings update.

success
boolean
required
campaign_updated
boolean
default:false
budget_updated
boolean
default:false
targeting_updated
boolean
default:false
conversion_goals_updated
boolean
default:false
warnings
string[]
errors
string[]