PUpumpgtm
Manual review

Approve candidates and enroll through the existing engine

Changed on

Mutating action: marks selected candidates good fit and queues newly enrolled leads. Requires exact Play and sequence revisions and the Play's own connected sender/sequence. An active eligible sequence can send on its next engine run. Does not activate, approve or change the sequence itself. Existing leads (including stopped/replied leads) keep their original state and sequence. Repeating a completed good-fit review returns already_reviewed; conflicting review decisions return 409. POST /plays/{id}/leads with this same candidateIds body does the same.

post/plays/{id}/enroll

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

expectedRevisioninteger required

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

sequenceIdstring uuid required
sequenceRevisioninteger required

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

candidateIdsstring[] required

Response

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

sequenceStatusstring nullable required
sequenceStatusChangedunknown required
reviewUrlstring 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