GMV Max

Create a GMV Max automation

Create a new automation that watches the selected campaign(s) and fires creative boosts when its conditions match. Requires read_write scope. Idempotent via the Idempotency-Key header — replays of the same key + same body return the cached 201 instead of creating a duplicate row.

X-Dry-Run: true validates the body and echoes the would-be row without touching the DB. Single shop only — set x-shop-id to the owning shop.

Every set_up_creative_boost action requires a total_creative_boost_cost guardrail (lifetime spend cap) — missing one returns 422 TOTAL_BUDGET_CAP_REQUIRED. Each campaign_id can only belong to one active automation at a time — conflicts return 422 CAMPAIGN_ALREADY_ASSIGNED.

post/gmv-max/automations

Headers

Idempotency-Keystring nullable

X-Dry-Runstring nullable

Request body

namestring required

template_typestring nullable

Optional reference to one of the /templates template_type values the automation was scaffolded from. Free-form — does not affect execution.

trigger_frequency'daily'

How often the automation evaluates its conditions.

Only daily is honoured by the offline execution engine today; the portal FE submits this value exclusively.

campaign_idsstring[]

TikTok GMV Max campaign IDs the automation acts on. Each campaign_id can only be assigned to one active automation at a time — the controller rejects conflicts with a 422.

boost_start_datestring date nullable

First day boosts may fire. Must be paired with boost_end_date. Window cannot exceed 90 days.

boost_end_datestring date nullable

Response

Dry-run echo (no automation created).

Changes

No recorded changes to this endpoint across all 1 revision of this API.