A valid request URL is required to generate request examples{
"campaignId": "cmp-3f8a1c02-9d41-4c7b-8b12-6a0f5d7e2c33",
"status": "sent",
"dryRun": false,
"plan": {
"channel": "email",
"audienceCount": 42,
"eligibleCount": 31,
"excludedNoConsentCount": 8,
"excludedNoContactCount": 3,
"recipients": [
{
"customerId": "cust-1",
"contact": "camille.renard@example.com"
}
]
},
"sentCount": 31,
"failedCount": 0
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Send a campaign to its consented audience (campagne, relance)
DELIVERS the campaign: it re-resolves the plan and hands every eligible recipient to the ESP. This reaches real customers and CANNOT be undone — run dryRunCampaign first and only send on an explicit human instruction. The response carries dryRun: when no ESP key is provisioned it is true and NOTHING was delivered (the plan comes back and the campaign’s status is left alone), so check that flag before reporting a send as done. Otherwise the campaign moves to sent, or to failed when the ESP rejected everything. Non-consented customers are never addressed. 404s for an unknown campaign.
A valid request URL is required to generate request examples{
"campaignId": "cmp-3f8a1c02-9d41-4c7b-8b12-6a0f5d7e2c33",
"status": "sent",
"dryRun": false,
"plan": {
"channel": "email",
"audienceCount": 42,
"eligibleCount": 31,
"excludedNoConsentCount": 8,
"excludedNoContactCount": 3,
"recipients": [
{
"customerId": "cust-1",
"contact": "camille.renard@example.com"
}
]
},
"sentCount": 31,
"failedCount": 0
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123,
"fieldErrors": [
{
"field": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"statusCode": 123
}
}Authorizations
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
The server-minted campaign id (cmp-<uuid>) to act on.
1Response
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.
1draft, scheduled, sending, sent, failed Show child attributes
Show child attributes
0 <= x <= 90071992547409910 <= x <= 9007199254740991
