REreacherapp
GMV Max

Stop a GMV Max automation

Changed on

Mark an automation status='stopped' (terminal — no resume). Already-stopped automations are returned unchanged (idempotent on the row itself, independent of the Idempotency-Key header).

Boost cancellation against TikTok is best-effort and runs in a background thread on the portal side; this endpoint does not wait for it. Single shop only.

post/gmv-max/automations/{automation_id}/stop

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/gmv-max/automations/{automation_id}/stop
  • 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

Response

Automation stopped (or already stopped).

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

  • 3530675d2c2aRevision changes
    • breaking

      the response's body type changed from no type to object for 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 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

  • 291230805105Revision changes
    • info

      api operation id stop_automation_gmv_max_automations__automation_id__stop_post removed and replaced with gmv_max_automation_stop