Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Path Parameters

id
string
required
Minimum string length: 1

Response

The dispatch outcome: the resolved plan, the dry-run flag and the counts.

The dispatch outcome: the resolved plan, the dry-run flag and the counts.

campaignId
string
required
Minimum string length: 1
status
enum<string>
required
Available options:
draft,
scheduled,
sending,
sent,
failed
dryRun
boolean
required
plan
object
required
sentCount
integer
required
Required range: 0 <= x <= 9007199254740991
failedCount
integer
required
Required range: 0 <= x <= 9007199254740991