REreacherapp
GMV Max

Change a session's budget or schedule

Changed on

TikTok's campaign/gmv_max/session/update: a new daily budget, start (max delivery only) or end. The session must be on this campaign, which must be on this shop's store; a session a Reacher automation runs is refused (409). Requires read_write scope. Idempotent via Idempotency-Key; X-Dry-Run: true runs the checks and echoes the TikTok body. Single shop only.

patch/gmv-max/campaigns/{campaign_id}/sessions/{session_id}

Request

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

Path parameters

campaign_idstring required
session_idstring required

Headers

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

Request body

daily_budgetnumber nullable

New daily budget.

schedule_type'from_now' | 'start_end' nullable

from_now removes the end; start_end needs schedule_end_time.

schedule_start_timestring nullable

Max delivery only: new start, UTC, at least 5 minutes from now.

schedule_end_timestring nullable

New 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