Campaign Briefs / REST API
Run icp canary gate
Run the canary quality gate for a brief after ICP scoring a sample. Computes the shared list-quality scorecard, persists latestScorecard, and returns pass/fail evidence so Scout can scale, pause, or ask for another ICP tuning round.
POST /api/v1/icp-tuning/canary-gateDeterministic operationParameters
workspaceIdOptional · string- Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
briefIdRequired · string- Campaign brief id.
requireIcpScoredRowsOptional · boolean- Default true. When true, returns a reason instead of scoring unscored rows.
curl -X POST "https://app.pipeline.help/api/v1/icp-tuning/canary-gate" \
-H "Authorization: Bearer $PIPELINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"briefId":"00000000-0000-4000-8000-000000000000"}'Full input schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1,
"description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
},
"briefId": {
"type": "string",
"description": "Campaign brief id."
},
"requireIcpScoredRows": {
"type": "boolean",
"description": "Default true. When true, returns a reason instead of scoring unscored rows."
}
},
"required": [
"briefId"
]
}