Campaigns / TypeScript SDK

Start campaign

Name: Pipeline
Price: 99 USD

Start a campaign to begin executing its workflow.

pipeline.startCampaignDeterministic operation

Parameters

workspaceIdOptional · string: Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
campaignIdRequired · string: See the input schema for this field.

Request example

await pipeline.startCampaign({
  "campaignId": "00000000-0000-4000-8000-000000000000"
})

Full input schema

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."
    },
    "campaignId": {
      "type": "string"
    }
  },
  "required": [
    "campaignId"
  ]
}

See this operation inCLI MCP REST API