Update Ad Campaign

PUT

/ad-campaigns/{campaign_id}

• Production
• QA

Edit a LIVE campaign: budget, schedule, creative, keywords, ad copy, targeting, pause or resume.

Omitted fields are left alone; an unknown field is a 422 (the app’s model forbids extras, so a typo cannot silently do nothing). Read GET /ad-campaigns/{campaign_id}/editable first - the platform refuses some changes on some campaign types and states.

A 200 is NOT blanket success: the response status is partial whenever any single change failed, and changes[] says which.

Authorizations

• BearerAuth

Parameters

Path Parameters

campaign_id

required

The ad campaign’s id.

integer

The ad campaign’s id.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Body for PUT /campaigns/{id} and POST /campaigns/{id}/edit-preview.

extra="forbid" is load-bearing (PRD hazard H8): the model used to inherit Pydantic’s default extra="ignore", so the wizard could POST a field the backend had never wired, get a 200, and render a green “Campaign updated” toast for an edit that reached nothing. An unknown field is now a 422 — a phantom control is structurally impossible to ship.

List-shaped fields (keywords, rsa_headlines, rsa_descriptions, geo_targets) are COMPLETE desired lists, never deltas. Google replaces repeated fields wholesale, so a partial list silently deletes the omitted entries; the handler read-modify-writes against the platform’s current state. None means “not provided / unchanged” — an empty list is a real request to clear, and is rejected where clearing would break the ad.

object

action

Any of:

string

string

null

null

auto_pause_at

Any of:

string

string format: date-time

null

null

auto_pause_tz

Any of:

string

string

<= 64 characters

null

null

campaign_negative_keywords

Any of:

Array<object>

Array<object>

object

key

additional properties

any

null

null

clear_auto_stop

boolean

creative_image_url

Any of:

string

string

<= 500 characters

null

null

creative_image_url_portrait

Any of:

string

string

<= 500 characters

null

null

creative_image_url_square

Any of:

string

string

<= 500 characters

null

null

cta

Any of:

string

string

null

null

daily_budget

Any of:

number

number

> 0

null

null

destination_url

Any of:

string

string

<= 500 characters

null

null

end_date

Any of:

string

string format: date

null

null

geo_targets

Any of:

Array<string>

Array<string>

null

null

headline

Any of:

string

string

<= 255 characters

null

null

keywords

Any of:

Array<object>

Array<object>

object

key

additional properties

any

null

null

logo_image_url

Any of:

string

string

<= 500 characters

null

null

name

Any of:

string

string

<= 255 characters

null

null

primary_text

Any of:

string

string

<= 1000 characters

null

null

rsa_descriptions

Any of:

Array<string>

Array<string>

null

null

rsa_headlines

Any of:

Array<string>

Array<string>

null

null

selected_channels

Any of:

object

object

key

additional properties

boolean

null

null

spend_cap

Any of:

number

number

> 0

null

null

video_asset_ids

Any of:

Array<integer>

Array<integer>

null

null

video_business_name

Any of:

string

string

<= 25 characters

null

null

video_cta

Any of:

string

string

null

null

video_descriptions

Any of:

Array<string>

Array<string>

null

null

video_headlines

Any of:

Array<string>

Array<string>

null

null

video_long_headlines

Any of:

Array<string>

Array<string>

null

null

Responses

200

Successful Response

object

data

required

One ad-platform object, or one handler response.

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string