Launch a draft campaign

Requires EDITOR. draft only (else 409). Requires an active template and provider (else 409) and the EMAIL_CAMPAIGN_EXPAND queue binding (else 503). Enqueues expansion.

Authorizations

• SessionCookie

Parameters

Path Parameters

projectId

required

string

Tenant project id (row-level isolation on every query).

campaignId

required

string

Campaign id.

Responses

200

Campaign moved to expanding.

Media typeapplication/json

object

campaign

Email campaign (serialized). See handler for the full field set.

object

id

string

projectId

string

name

string

status

string

Allowed values: draft queued expanding sending paused completed aborted

templateId

string

providerId

string | null

identityId

string | null

audienceFilter

Segment predicate shared by campaigns and trigger userFilter (all fields optional).

object

locale

One of:

string

string

Array<string>

Array<string>

hasEmail

boolean

hasPhone

boolean

userIdLike

string

firstSeenFrom

string format: date-time

firstSeenTo

string format: date-time

lastSeenFrom

string format: date-time

lastSeenTo

string format: date-time

savedAudienceId

string

queueKey

string

Allowed values: new_paid_activation key_created_low_usage high_balance_inactive high_value low_balance_renewal churn_risk_paid

paidStatus

One of:

string

string

Array<string>

Array<string>

valueTier

One of:

string

string

Array<string>

Array<string>

minLtv

number

maxLtv

number

minBalance

number

maxBalance

number

minUsage30d

number

maxUsage30d

number

lastPurchaseFrom

string format: date-time

lastPurchaseTo

string format: date-time

lifecycleStage

One of:

string

string

Array<string>

Array<string>

recommendedAction

One of:

string

string

Array<string>

Array<string>

variables

object | null

estimatedRecipients

integer

suppressionPreview

integer

sendRatePerSecond

integer

scheduledAt

string | null format: date-time

launchAt

string | null format: date-time

expandedCount

integer

sentCount

integer

deliveredCount

integer

openedCount

integer

clickedCount

integer

failedCount

integer

suppressedCount

integer

abortedReason

string | null

quotaDeferredCount

integer

lastQuotaDeferredAt

string | null format: date-time

createdBy

string | null

createdAt

string format: date-time

updatedAt

string format: date-time

startedAt

string | null format: date-time

completedAt

string | null format: date-time

401

Not authenticated (no valid session/principal).

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

403

Authenticated but lacks the required project role.

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

404

Resource not found (or belongs to another project — indistinguishable).

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

409

Not draft, or no active template/provider.

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

503

Campaign expand queue not bound.

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}