PUpumpgtm
Sequences

Create a complete sequence

Changed on

Save a complete sequence with the same step rules and approval rule as the PumpGTM agent tools. Your request is the approval: with a workspace or partner key the sequence is approved and live when this returns (live: true). Nothing is sent until people are added, and sends follow working hours, account limits and reply freezes. X steps need the X channel and executionModel tracks needs multichannel_tracks (403 feature_disabled). requestId (8-120 characters, first alphanumeric) replays the stored result with replayed: true when reused with the same body; 409 sequence_create_request_conflict when reused with different content; 409 sequence_steps_invalid with detail when step rules are broken.

post/sequences

Request

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

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.

namestring required
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.

sequenceobject required

Full sequence: { id, name, status, revision, approvedAt, approvedRevision, executionBlockReason, executionModel, leadCount, channels, steps: [{ stepIndex, kind, delayDays, subject, messageTmpl, actions, variants, tool }], updatedAt }. Steps use the same names as the request body (stepIndex, messageTmpl), unlike the compact GET /sequences list (index, message).

reviewUrlstring required
liveboolean required

Changes

  • 06d2e4d0e84bRevision 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

  • 08c80059d483Revision changes
    • info

      endpoint added