Leads

Stop this lead's future automation

Changed on

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.

post/x/leads/{id}/stop

Request

  • Base URL
    https://app.pumpgtm.com/api/v1
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Headers

X-PumpGTM-Clientstring uuid

Optional authorized Team workspace ID from GET /workspaces. Omit to use the key's home workspace.

X-PumpGTM-Userstring

Enterprise partners: act on one end user's workspace using the partner key (a workspace or Team owner key; a personal key gets 403 partner_key_required). Requires the outreach capability on the partner account (403 enterprise_required otherwise); the user must exist and be active (404 user_not_found, 403 user_disabled). Never send it together with X-PumpGTM-Client (400 invalid_request). Omit to use the key's own workspace, unless the partner account has rest.requireUserHeader on (PATCH /api/partner/v1/account): then any /api/v1 request without it is 400 user_header_required and nothing runs.

Response

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

okunknown required
scope'lead_automation' required
permanentSuppressionunknown required
notestring required

Changes

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      endpoint added