sdkDeterministic

Launch prepared campaign

pipeline.launchPreparedCampaign

Activate a campaign that was prepared by prepare-campaign-launch. Requires the exact expiring approvalId and confirm=true. Revalidates workspace ownership and campaign draft status, atomically consumes the approval, and starts delivery idempotently.

Parameters

workspaceId

string

Optional with API-key auth. Inferred from the key.

approvalIdrequired

string

Approval ID returned by prepare-campaign-launch.

confirmrequired

boolean

Must be true after the operator explicitly approves the preview.

Example

TypeScripttypescript

await pipeline.launchPreparedCampaign({
  "approvalId": "00000000-0000-4000-8000-000000000000",
  "confirm": true
})

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "launched": {
      "type": "boolean"
    },
    "reason": {
      "type": "string"
    },
    "campaignId": {
      "type": "string"
    },
    "prospectsUploaded": {
      "type": "number"
    },
    "sourceTableIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "channels": {
      "type": "object"
    }
  },
  "required": [
    "launched"
  ]
}

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.