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

apiDeterministic

Preview campaign source

POST /api/v1/strategy/source-preview

Persist the exact campaign-bound sourcing preview before pilot rows are written. Accepts at most 10 rows plus the claimed work order, active brief version, provider, resolved filters, and verified result ceiling. Returns an immutable sourcingPreviewId required by the pilot add-table-rows call.

Parameters

workspaceId

string

Optional with API key auth, inferred from the key.

claimTokenrequired

string

No description.

workOrderIdrequired

string

No description.

briefIdrequired

string

No description.

briefVersionrequired

integer

No description.

sourceScoperequired

string

No description.

providerrequired

string

No description.

accountId

string

No description.

resolvedFiltersrequired

object

No description.

requestedLimit

integer

No description.

availableCount

integer

No description.

rowsrequired

object[]

No description.

rejectedRows

object[]

No description.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/v1/strategy/source-preview" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"claimToken":"example","workOrderId":"00000000-0000-4000-8000-000000000000","briefId":"00000000-0000-4000-8000-000000000000","briefVersion":1,"sourceScope":"example","provider":"example","resolvedFilters":{},"rows":[{"data":{}}]}'

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "sourcingPreviewId": {
      "type": "string",
      "format": "uuid"
    },
    "preview": {
      "type": "object"
    },
    "verifiedCeiling": {
      "type": "number"
    }
  },
  "required": [
    "sourcingPreviewId",
    "preview",
    "verifiedCeiling"
  ]
}

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.