Leads

Supply per-person values for a held message step

Changed on

Store the customer's values for a message step declared with tool { kind: "customer_input", tokens }, for example a link to a video they recorded. 1-5 entries; keys are the sequence's token names; a *_url key must be an http(s) URL. Nothing is sent in this call: the paced engine sends on its next run. 409 with nothing changed: lead_input_already_replied, lead_input_sequence_finished, lead_input_step_already_sent, lead_input_no_sequence, lead_input_sequence_has_no_input_step, lead_input_unknown_key, lead_input_invalid_value, lead_input_step_uses_generated_asset.

post/leads/{id}/input

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

valuesobject required

Response

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

storedobject required

{ leadId, person, company, linkedinUrl, sequenceId, sequenceName, stepIndex, storedKeys, complete, stillMissing, willSendOn, stillWaitingInSequence }

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