Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiHosted AI, explicit consent

Score prospect

POST /api/prospects/{prospectId}/score

Score a prospect against the workspace ICP.

Parameters

workspaceIdrequired

string

No description.

prospectIdrequired

string

No description.

allowHostedAi

boolean

Must be true when this operation uses Pipeline hosted inference.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/prospects/00000000-0000-4000-8000-000000000000/score" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "X-Pipeline-Execution-Policy: hosted-enabled" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"00000000-0000-4000-8000-000000000000","allowHostedAi":true}'

Response

The operation is available, but its typed response schema has not been published yet.

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.