REreacherapp
GMV Max

Exclude videos from GMV Max campaigns

Changed on

Exclude the given videos from the given campaigns, leaving the same videos live in the shop's other campaigns. Idempotent on (shop, campaign, video): re-excluding an already-excluded placement is a no-op. Ids that are not a numeric TikTok video id come back in invalid, never silently dropped. Requires read_write scope and an Idempotency-Key. Single shop only.

post/gmv-max/campaign-exclusions/exclude

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/gmv-max/campaign-exclusions/exclude
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Headers

Idempotency-Keystring nullable

Request body

campaign_idsstring[] required

TikTok campaign ids to scope the exclusion to (max 100 per call) — the same campaign ids returned by GET /gmv-max/campaigns.

video_idsstring[] required

TikTok video ids to exclude from the named campaigns (max 500 per call). Pasted URLs are unwrapped; ids that are not a numeric TikTok video id are returned in invalid, never silently dropped.

reasonstring nullable

Optional free-text note stored on every row created by this call.

Response

Successful Response

Changes