---
title: "Stop a GMV Max automation"
method: POST
path: "/gmv-max/automations/{automation_id}/stop"
tags: ["GMV Max"]
---

# Stop a GMV Max automation

`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`

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.

## Path parameters

- `automation_id` integer, required

## Headers

- `Idempotency-Key` string, nullable
- `X-Dry-Run` string, nullable

## Response `200`

Automation stopped (or already stopped).

- AutomationResponse
  - `id` integer, required
  - `shop_id` integer, required
  - `name` string, required
  - `template_type` string, nullable
  - `status` string, 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_frequency` string, required
  - `campaign_ids` unknown[]
    - unknown
  - `conditions` unknown[]
    - unknown
  - `actions` unknown[]
    - unknown
  - `guardrails` unknown[]
    - unknown
  - `last_run_at` string, date-time, nullable
  - `next_run_at` string, date-time, nullable
  - `boost_start_date` string, date, nullable
  - `boost_end_date` string, date, nullable
  - `is_editable` boolean
  - `created_by` string, nullable
  - `created_at` string, date-time, nullable
  - `updated_at` string, date-time, nullable

## Other responses

- `403`: API key lacks `read_write` scope.
- `404`: Automation not found in this shop.
- `409`: Idempotency-Key conflict.
- `422`: Validation Error
- `429`: Write rate limit exceeded.

## Changes

> 76 revisions in range; 1 not diffed.

- **2026-10-04** `3530675d2c2a`: 1 breaking, 18 info
  - the response's body type changed from no type to `object` for status `200`
  - added the optional property `actions` to the response with the `200` status
  - added the optional property `boost_end_date` to the response with the `200` status
  - added the optional property `boost_start_date` to the response with the `200` status
  - …15 more
- **2026-09-19** `291230805105`: 1 info
  - api operation id `stop_automation_gmv_max_automations__automation_id__stop_post` removed and replaced with `gmv_max_automation_stop`

[Operation history](https://skmtc.dev/reacherapp/apis/reacher-data-api/changes/gmv-max/automations/:automation_id/stop/post.md)

---

[API](https://skmtc.dev/reacherapp/apis/reacher-data-api.md) - [All operations](https://skmtc.dev/reacherapp/apis/reacher-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reacherapp/apis/reacher-data-api/revisions/63ce74b30b5a?raw)