sdkDeterministic

Apply campaign revision

pipeline.applyCampaignRevision

Apply an exact previewed prelaunch campaign revision after confirmation. Refuses stale previews and live or scheduled campaigns. Does not source, research, write, schedule, or send.

Parameters

workspaceIdrequired

string

No description.

briefIdrequired

string

No description.

segmentIdrequired

string

No description.

expectedVersionrequired

integer

No description.

proposedPlanrequired

object

No description.

expectedSegmentUpdatedAt

string

No description.

segmentPatch

object

No description.

reason

string

No description.

proposalFingerprintrequired

string

No description.

rowCohortrequired

object

No description.

confirmrequired

boolean

No description.

Example

TypeScripttypescript

await pipeline.applyCampaignRevision({
  "workspaceId": "00000000-0000-4000-8000-000000000001",
  "briefId": "00000000-0000-4000-8000-000000000002",
  "segmentId": "00000000-0000-4000-8000-000000000003",
  "expectedVersion": 1,
  "proposedPlan": {},
  "proposalFingerprint": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "rowCohort": {},
  "confirm": true
})

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "version": {
      "type": "number"
    },
    "alreadyApplied": {
      "type": "boolean"
    },
    "changedFields": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "proposalFingerprint": {
      "type": "string"
    },
    "impact": {
      "type": "object"
    },
    "validation": {
      "type": "object"
    }
  },
  "required": [
    "version",
    "alreadyApplied",
    "changedFields",
    "proposalFingerprint",
    "impact",
    "validation"
  ]
}

Exceptions

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