Skip to main content
POST
Import Campaign Workbooks

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Body

application/json
documentIds
string<uuid>[]
required

1–10 uploaded Excel document IDs, deduplicated in requested order.

Required array length: 1 - 10 elements
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
ownerId
string

Organization member or active organization API client actor ID from campaign options; defaults to the executing actor.

Required string length: 1 - 160
approverId
string

Named organization member or active organization API client actor ID from campaign options; defaults to the executing actor. Only this actor can approve or start.

Required string length: 1 - 160
stores
object[]
Maximum array length: 100
timezone
string
preview
boolean
default:true
campaignId
string

Update this existing campaign from one re-uploaded workbook instead of creating a campaign. Only values changed since its previous workbook apply; a running campaign gets a pending live change for its approver.

Required string length: 1 - 160
applyChanges
boolean
default:false

With campaignId and preview=false, the named approver applies this running campaign update and queues marketplace delivery immediately. Requires the reviewed expectedRevision and expectedPendingVersion (null when none).

expectedRevision
integer
Required range: x <= 9007199254740991
expectedPendingVersion
integer | null
Required range: 0 < x <= 9007199254740991
organizationId
string

Required for session auth. Optional for an API key, which already identifies the organization.

Required string length: 1 - 120

Response

Canonical operation result. Inspect aggregate and per-target success and marketplace delivery evidence.

success
boolean
required
succeededCount
integer
required
Required range: 0 <= x <= 9007199254740991
failedCount
integer
required
Required range: 0 <= x <= 9007199254740991
documentIds
string[]
required
results
object[]
required