REreacherapp
GMV Max

Update a GMV Max automation

Changed on

Patch an existing automation. Only active, non-expired automations are editable — stopped, deleted, or past-end-date rows return 422 with AUTOMATION_NOT_EDITABLE or AUTOMATION_EXPIRED.

PATCH semantics — fields the caller does NOT include are left unchanged. Sending null for boost_start_date / boost_end_date clears the boost window (both dates must be sent together).

X-Dry-Run: true runs every check the update runs and echoes the patch without writing. Idempotent via the Idempotency-Key header. Single shop only.

put/gmv-max/automations/{automation_id}

Request

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

Path parameters

automation_idinteger required

Headers

Idempotency-Keystring nullable
X-Dry-Runstring nullable

Request body

namestring nullable
trigger_frequency'daily'

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

campaign_idsstring[] nullable
boost_start_datestring date nullable
boost_end_datestring date nullable

Response

Automation updated (or dry-run echo).

idinteger required
shop_idinteger required
namestring required
template_typestring nullable
statusstring required

Effective automation status: 'active', 'stopped', 'deleted', or the derived 'expired' — an 'active' boost whose boost_end_date has passed. Filter on 'expired' to exclude boosts that have ended.

trigger_frequencystring required
last_run_atstring date-time nullable
next_run_atstring date-time nullable
boost_start_datestring date nullable
boost_end_datestring date nullable
is_editableboolean
created_bystring nullable
created_atstring date-time nullable
updated_atstring date-time nullable

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