sdkDeterministic

Update campaign brief

pipeline.updateCampaignBrief

Edit an existing campaign brief without hosted AI. Pass a partial plan, including name, frontEndOffer {name, description, whyIcpWantsIt}, or operatingContract with offerScore {deliveryCost, prospectValue, competenceProof, painFit, linkedinFriction, reasoning, total, verdict}. Scores are integers 1-5; total is their sum; verdict strong at 21+, usable at 16+, otherwise weak. Preserve other operatingContract fields. Asset selection uses selectedAssetBinding and is validated server-side.

Parameters

workspaceId
string
Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
briefIdrequired
string
No description.
plan
object
No description.
status
string
No description.
draft | active | paused | exhausted | archived
icpProfileId
string | null
No description.
selectedAssetBinding
object | null
No description.

Example

TypeScripttypescript
await pipeline.updateCampaignBrief({
"briefId": "00000000-0000-4000-8000-000000000000"
})

Response

Success response schemajson schema
{
"type": "object",
"properties": {
"brief": {
"type": "object",
"additionalProperties": true
},
"scoutPaused": {
"type": "boolean"
}
},
"required": [
"brief",
"scoutPaused"
]
}

Exceptions

PipelineError
Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.
Pipeline TypeScript SDK documentation | Pipeline