Sequences

Replace a sequence's steps as a new revision

Changed on

Complete revisioned replacement: read GET /sequences/{id} first and send the full step list (stepIndex, messageTmpl) with the current revision from that response; the compact list shape is not accepted. With a customer credential the new revision is re-approved and the sequence returns to its previous status (active stays active, paused stays paused, a draft goes live). Omitted executionModel keeps the current one and may change only on a draft nobody has been worked through. 409 with nothing changed: sequence_revision_conflict, sequence_edit_request_conflict, sequence_has_progress, archived_sequence_is_read_only, sequence_must_be_draft, sequence_steps_invalid; the body carries update.currentRevision where known.

put/sequences/{id}

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

requestIdstring

Optional idempotency key; reuse it only to retry this exact request. Omitted means a fresh request.

expectedRevisioninteger required

Current saved revision. Fetch again after a 409; do not silently retry a changed plan.

namestring
executionModel'linear' | 'tracks'

linear (default) runs steps in order; tracks runs LinkedIn, email and X steps as parallel lanes per person and needs the multichannel_tracks feature.

xThreadCheckboolean

Workspace-wide X setting, applies to every sequence: check the conversation before each X DM so nobody the customer already talks to is messaged (5 Energy per DM instead of 0.6). Default off.

Response

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

updateobject required

{ ok: true, replayed, sequence, live, change: { previousRevision, revision, currentRevision, previousStatus, nameChanged, stepCountBefore, stepCountAfter, changedStepIndexes, approvalInvalidated } }

reviewUrlstring 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