Sequences

Pause or resume an existing sequence

Changed on

Affects every lead in this sequence. active may enable sending, subject to existing approval, billing, budget and provider controls. paused halts future sequence work; already dispatched actions cannot be recalled. Does not edit or approve content. 400 { error: "status must be one of active, paused, draft" } for any other value; 404 { error: "sequence not found" } outside this workspace; 409 { ok: false, error: sequence_approval_required | archived_sequence_is_read_only } when the change is refused.

patch/sequences/{id}/status

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.

Request body

status'active' | 'paused' | 'draft' required

Response

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

okunknown required
sequenceIdstring uuid required
previousStatus'draft' | 'active' | 'paused' | 'archived' required
status'active' | 'paused' | 'draft' 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