sdkProvider-backed

Activate segment pilot

pipeline.activateSegmentPilot

Activate one explicitly selected Launchpad segment. Deterministically creates or repairs its campaign brief, ICP profile, draft campaign, and Agent Teams table, then sources up to 10 pilot rows through the segment's connected provider and stops at a review approval. Does not scale, research, write copy, or launch the campaign.

Parameters

workspaceIdrequired

string

No description.

segmentIdrequired

string

Exact segment ID returned by list-segments. Never infer or auto-select it.

targetLeadCount

number

Planned total audience after pilot approval. The initial pilot remains capped at 10 rows.

Example

TypeScripttypescript

await pipeline.activateSegmentPilot({
  "workspaceId": "00000000-0000-4000-8000-000000000000",
  "segmentId": "00000000-0000-4000-8000-000000000000"
})

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "segmentId": {
      "type": "string"
    },
    "briefId": {
      "type": "string"
    },
    "icpProfileId": {
      "type": [
        "string",
        "null"
      ]
    },
    "tableId": {
      "type": "string"
    },
    "campaignId": {
      "type": [
        "string",
        "null"
      ]
    },
    "state": {
      "type": "string"
    },
    "alreadyActive": {
      "type": "boolean"
    },
    "repaired": {
      "type": "boolean"
    },
    "pendingApprovalId": {
      "type": [
        "string",
        "null"
      ]
    },
    "targetLeadCount": {
      "type": "number"
    },
    "pilotInserted": {
      "type": "number"
    },
    "pilotSkipped": {
      "type": "number"
    },
    "warning": {
      "type": "string"
    }
  },
  "required": [
    "segmentId",
    "briefId",
    "icpProfileId",
    "tableId",
    "campaignId",
    "state",
    "alreadyActive",
    "repaired",
    "pendingApprovalId",
    "targetLeadCount"
  ]
}

Exceptions

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