Campaign Briefs / TypeScript SDK
Get campaign brief
Fetch one campaign brief by id. Returns the full BriefPlan: targeting, sources, offers, cadence, personalization template, ICP rubric, and the latest scorecard snapshot if one has been computed. Read-only.
pipeline.getCampaignBriefDeterministic 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- See the input schema for this field.
await pipeline.getCampaignBrief({
"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"
}
},
"required": [
"briefId"
]
}