PUpumpgtm
People search

Record good-fit decisions and enroll

Changed on

Record the customer's good-fit decisions on a review batch. 1-100 decisions per call; good_fit approves, not_a_fit rejects. Partial decisions persist. finish: true requires every candidate decided and queues the good fits into their sequence (the call's sequenceId, a per-decision override, or the Play's default); summary, addedLeadIds, addedLeads and sequences are present only on that finishing call, and reviewUrl is then present. Nothing is sent in this call. 409 all_candidates_require_a_decision when finishing with undecided people.

post/people/reviews/{batchId}/decisions

Request

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

Path parameters

batchIdstring 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

sequenceIdstring uuid

Applies to every good fit in this call.

finishboolean
requestIdstring

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

Response

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

object required

{ batch, candidates: [{ ..., decision: undecided | approved | rejected }], reviewUrl?, contacted: false } plus, only when finish is true: summary: { approvedCount, rejectedCount, addedCount, duplicatesSkipped, alreadyInvitedCount }, addedLeadIds, addedLeads, sequences

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