Sign in
GMV Max

Update a GMV Max campaign

Patch the mutable subset of a GMV Max campaign — daily budget, target ROAS, name, and pause/resume (operation_status). Requires read_write scope. PATCH semantics — fields the caller omits are left unchanged; at least one field must be provided.

The shop must be connected to TikTok Business / GMV Max (400 INVALID_REQUEST otherwise). Idempotent via the Idempotency-Key header. X-Dry-Run: true echoes the mapped TikTok patch without calling TikTok. Single shop only.

patch/gmv-max/campaigns/{campaign_id}

Path parameters

campaign_idstring required

Headers

Idempotency-Keystring nullable
X-Dry-Runstring nullable
X-Created-Viastring nullable

Request body

campaign_namestring nullable
daily_budgetnumber nullable

New daily budget. Maps to TikTok budget.

target_roasnumber nullable

New target ROAS. Maps to TikTok roas_bid.

operation_status'ENABLE' | 'DISABLE' nullable

Pause (DISABLE) or resume (ENABLE) the campaign. Maps to TikTok operation_status.

promotion_daysinteger nullable
auto_budget_enabledboolean nullable

Response

Campaign updated (or dry-run echo).

{"stackTrail":"paths:/gmv-max/campaigns/{campaign_id}:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 1 of the 4 revisions of this API.1