---
title: "Stop this lead's future automation"
method: POST
path: "/x/leads/{id}/stop"
tags: ["Leads"]
---

# Stop this lead's future automation

`POST /x/leads/{id}/stop`

## Request

- Base URL: `https://app.pumpgtm.com/api/v1`
- URL: `https://app.pumpgtm.com/api/v1/x/leads/{id}/stop`
- Auth: HTTP bearer

Idempotent stop using the existing removal controls. Stops all sequence lanes for this lead, preserving contacted history; uncontacted queued leads become skipped. Available even after X is disabled. Does not recall dispatched actions, permanently suppress the identity, or delete history.

## Path parameters

- `id` string, uuid, required

## Headers

- `X-PumpGTM-Client` string, uuid
- `X-PumpGTM-User` string

## Response `200`

Successful response. Read outcome fields; success does not imply delivery.

- object
  - `ok` unknown, required
  - `lead` object, nullable, required
    - `id` string, uuid, required
    - `xUserId` string, nullable, required: Numeric X user ID as a string. Never convert it to a JavaScript number.
    - `username` string, nullable, required
    - `accountUserId` string, nullable, required: Numeric X user ID as a string. Never convert it to a JavaScript number.
    - `playId` string, uuid, nullable, required
    - `sequenceId` string, uuid, nullable, required
    - `stage` string, required
    - `automationStopped` boolean, required
    - `currentStep` integer, required
    - `nextActionAt` string, nullable, required
    - `followedAt` string, nullable, required
    - `followedBackAt` string, nullable, required
    - `messagedAt` string, nullable, required
    - `repliedAt` string, nullable, required
    - `optedOutAt` string, nullable, required
    - `deliveryGuaranteed` unknown, required
  - `scope` 'lead_automation', required
  - `permanentSuppression` unknown, required
  - `note` string, required

## Other responses

- `400`: Invalid input; for partner keys also user_header_required when the account requires X-PumpGTM-User
- `401`: Missing, invalid or revoked key
- `403`: Workspace mismatch, channel or feature disabled; for partner keys also enterprise_required and user_disabled
- `404`: Resource unavailable in this workspace
- `409`: Revision, identity or state conflict: { error, message } and nothing changed
- `429`: Rate limit; respect Retry-After when provided
- `500`: internal_error: an unexpected failure on our side; retry, then contact PumpGTM
- `503`: Dependency unavailable; identity may be unknown

## Changes

- **2026-10-12** `06d2e4d0e84b`: 8 info
  - the response property `error` became required for the status `400`
  - the response property `error` became required for the status `401`
  - the response property `error` became required for the status `403`
  - the response property `error` became required for the status `404`
  - …4 more
- **2026-10-12** `08c80059d483`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pumpgtm/apis/pumpgtm-api/changes/x/leads/:id/stop/post.md)

---

[API](https://skmtc.dev/pumpgtm/apis/pumpgtm-api.md) - [All operations](https://skmtc.dev/pumpgtm/apis/pumpgtm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pumpgtm/apis/pumpgtm-api/revisions/06d2e4d0e84b?raw)