REreacherapp
GMV Max

Start a max delivery or creative boost session

Changed on

Spends extra daily budget on one product (max_delivery, TikTok NO_BID) or one post (creative_boost, CREATIVE_NO_BID) in a Product GMV Max campaign, through TikTok's campaign/gmv_max/session/create. The campaign must be on this shop's store, and a post a Reacher creative boost automation is already boosting is refused (409). Requires read_write scope. Idempotent via the Idempotency-Key header; X-Dry-Run: true checks the campaign and echoes the TikTok body without spending anything. Single shop only.

post/gmv-max/campaigns/{campaign_id}/sessions

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/gmv-max/campaigns/{campaign_id}/sessions
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Path parameters

campaign_idstring required

Headers

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

Request body

session_type'max_delivery' | 'creative_boost' required

max_delivery puts extra budget behind a product (TikTok NO_BID); creative_boost behind one post (CREATIVE_NO_BID).

spu_idstring required

The product (SPU ID); see gmv_max_store_products.

item_idstring nullable

Creative boost only (required): the post (video) ID, from gmv_max_posts or the campaign's report.

daily_budgetnumber required

Daily budget for the session, on top of the campaign's. TikTok's minimum is 10 USD.

schedule_type'from_now' | 'start_end'

from_now runs until the campaign ends; start_end until schedule_end_time.

schedule_start_timestring nullable

Max delivery only: start, YYYY-MM-DD HH:MM:SS UTC (default now). Creative boost starts immediately.

schedule_end_timestring nullable

End, YYYY-MM-DD HH:MM:SS UTC.

Response

Successful Response

campaign_idstring required
session_idstring nullable

The session written (TikTok's id, on create).

action'created' | 'updated' | 'deleted' required
dry_runboolean nullable

True when nothing was sent to TikTok.

wouldobject nullable

Dry run only: the TikTok request body.

Changes