PUpumpgtm
People search

Run an existing people-search Play

Changed on

Runs a saved people-search Play as is; same metering and result as createPeopleSearch with run: true. requestId is required: a run is billed, so a retry must carry the same requestId to replay the stored result instead of searching and charging again. 404 not_found (resource play) when the Play does not exist or is not a people-search Play.

post/people/searches/{playId}/run

Request

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

Path parameters

playIdstring 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 required

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

sequenceIdstring uuid

Response

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

object 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

    • info

      the response property became required for the status

  • 08c80059d483Revision changes
    • info

      endpoint added