REreacherapp
GMV Max

Create a GMV Max automation

Changed on

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. A condition or guardrail the boost engine cannot enforce (e.g. metric roi, operator >=) returns 422 UNENFORCEABLE_RULE naming it.

post/gmv-max/automations

Request

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

Headers

Idempotency-Keystring nullable
X-Dry-Runstring nullable

Request body

namestring required
template_typestring nullable

The /templates template_type the automation was scaffolded from. Does not affect execution.

trigger_frequency'daily'

How often the automation evaluates its conditions. Only daily runs.

campaign_idsstring[]

TikTok GMV Max campaign IDs the automation acts on. A campaign belongs to one active automation at a time.

boost_start_datestring date nullable

First day boosts may fire. Sent together with boost_end_date; the window is at most 90 days.

boost_end_datestring date nullable

Response

Dry-run echo (no automation created).

Changes

  • 8a05d3dfc50aRevision changes
    • info

      added the new creative_orders enum value to the request property //

    • info

      added the new lte enum value to the request property //

    • info

      added the new lte enum value to the request property ///

  • 3530675d2c2aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new 2s_video_view_rate enum value to the request property //

    • info

      added the new campaign_engagement_rate enum value to the request property //

    • info

      added the new click_through_rate enum value to the request property //

    • info

      added the new cost enum value to the request property //

    • info

      added the new creative_cost enum value to the request property //

    • info

      added the new creative_ctr enum value to the request property //

    • info

      added the new creative_ctr enum value to the request property //

    • info

      added the new gt enum value to the request property //

    • info

      added the new gt enum value to the request property ///

    • info

      added the new organic_engagement_rate enum value to the request property //

    • info

      added the new product_ad_click_rate enum value to the request property //

    • info

      added the new product_ad_click_rate enum value to the request property //

    • info

      added the new product_ad_clicks enum value to the request property //

    • info

      added the new total_creative_boost_cost enum value to the request property //

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status