Campaign Briefs / TypeScript SDK

Preview campaign source

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.

pipeline.previewCampaignSourceDeterministic operation

Parameters

workspaceIdOptional · string: Optional with API key auth, inferred from the key.
claimTokenRequired · string: See the input schema for this field.
workOrderIdRequired · string: See the input schema for this field.
briefIdRequired · string: See the input schema for this field.
briefVersionRequired · integer: See the input schema for this field.
sourceScopeRequired · string: See the input schema for this field.
providerRequired · string: See the input schema for this field.
accountIdOptional · string: See the input schema for this field.
resolvedFiltersRequired · object: See the input schema for this field.
requestedLimitOptional · integer: See the input schema for this field.
availableCountOptional · integer: See the input schema for this field.
rowsRequired · array: See the input schema for this field.
rejectedRowsOptional · array: See the input schema for this field.

Request example

await pipeline.previewCampaignSource({
  "claimToken": "example",
  "workOrderId": "00000000-0000-4000-8000-000000000000",
  "briefId": "00000000-0000-4000-8000-000000000000",
  "briefVersion": 1,
  "sourceScope": "example",
  "provider": "example",
  "resolvedFilters": {},
  "rows": [
    {
      "data": {}
    }
  ]
})

Full input schema

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "description": "Optional with API key auth, inferred from the key."
    },
    "claimToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "workOrderId": {
      "type": "string",
      "format": "uuid"
    },
    "briefId": {
      "type": "string",
      "format": "uuid"
    },
    "briefVersion": {
      "type": "integer",
      "minimum": 1
    },
    "sourceScope": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "provider": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "accountId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "resolvedFilters": {
      "type": "object",
      "additionalProperties": true
    },
    "requestedLimit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10,
      "default": 10
    },
    "availableCount": {
      "type": "integer",
      "minimum": 0
    },
    "rows": {
      "type": "array",
      "maxItems": 10,
      "items": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "additionalProperties": true
          },
          "position": {
            "type": "integer",
            "minimum": 0
          }
        },
        "required": [
          "data"
        ],
        "additionalProperties": false
      }
    },
    "rejectedRows": {
      "type": "array",
      "maxItems": 100,
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    }
  },
  "required": [
    "claimToken",
    "workOrderId",
    "briefId",
    "briefVersion",
    "sourceScope",
    "provider",
    "resolvedFilters",
    "rows"
  ],
  "additionalProperties": false
}

See this operation inCLI MCP REST API