Error
A valid request URL is required to generate request examples{
"id": "cmp-3f8a1c02-9d41-4c7b-8b12-6a0f5d7e2c33",
"name": "Soldes été 2026",
"channel": "email",
"segment": {
"segment": "champions",
"minMonetaryCents": 50000
},
"content": {
"subject": "Vos soldes en avant-première",
"body": "Profitez de -20% ce week-end."
},
"couponBatchRef": "SUMMER26",
"status": "draft",
"audienceCount": 0,
"recipientCount": 0,
"sentCount": 0,
"failedCount": 0,
"createdAt": "2026-07-28T09:00:00.000Z",
"updatedAt": "2026-07-28T09:00:00.000Z"
}{
"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
}
}Marketing
Get a campaign by id (campagne)
Returns one campaign: its authored fields plus the live status and the audienceCount / recipientCount / sentCount / failedCount recorded at its last dispatch. Poll this after sendCampaign to observe the outcome. 404s for an unknown id.
GET
/
v1
/
campaigns
/
{id}
Error
A valid request URL is required to generate request examples{
"id": "cmp-3f8a1c02-9d41-4c7b-8b12-6a0f5d7e2c33",
"name": "Soldes été 2026",
"channel": "email",
"segment": {
"segment": "champions",
"minMonetaryCents": 50000
},
"content": {
"subject": "Vos soldes en avant-première",
"body": "Profitez de -20% ce week-end."
},
"couponBatchRef": "SUMMER26",
"status": "draft",
"audienceCount": 0,
"recipientCount": 0,
"sentCount": 0,
"failedCount": 0,
"createdAt": "2026-07-28T09:00:00.000Z",
"updatedAt": "2026-07-28T09:00:00.000Z"
}{
"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.
Minimum string length:
1Response
The campaign with its current dispatch state.
The campaign with its current dispatch state.
Minimum string length:
1Minimum string length:
1Available options:
email, sms Show child attributes
Show child attributes
Available options:
draft, scheduled, sending, sent, failed Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Pattern:
^(?:(?:\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))$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))$Minimum string length:
1Show child attributes
Show child attributes
Minimum string length:
1Pattern:
^(?:(?:\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))$