Skip to main content
POST
Schedule campaign

Authorizations

Authorization
string
header
required

Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID
string
required
campaignID
string
required

Body

application/json
dispatchAt
string<date-time> | null

When to start dispatching: ISO 8601 datetime with offset or Z. Omit/null for immediate dispatch; a value more than 5 minutes in the past is rejected.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
excludedContactIDs
string[]

Contacts explicitly removed from the final audience.

filters
object[]

Segment rules to resolve into recipients — same wire format as /contacts/segment.

importedContactIDs
string[]

Contacts resolved from a CSV import.

manualContactIDs
string[]

Contacts picked manually by the operator.

variableConfigs
object

Value source per template variable key (from the campaign model catalog) — fixed or per-contact.

Response

Response for status 200.

campaignID
string
required
campaignPreparationStatus
enum<string>
required

The dispatches are written after this response, in the background. Follow GET …/campaigns/:campaignID until campaignPreparationStatus is prepared (or failed, with campaignPreparationError).

Available options:
preparing
campaignStatus
string
required

processing for an immediate dispatch, scheduled for a future dispatchAt. The campaign is no longer a draft.