Error

A valid request URL is required to generate request examples

{
  "channel": "email",
  "audienceCount": 42,
  "eligibleCount": 31,
  "excludedNoConsentCount": 8,
  "excludedNoContactCount": 3,
  "recipients": [
    {
      "customerId": "cust-1",
      "contact": "camille.renard@example.com"
    }
  ]
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

Marketing

Preview a campaign's recipients without sending (campagne, relance)

Resolves the campaign’s audience from its saved segment, filters it by per-channel consent (marketing_email for email, marketing_sms for SMS) and a usable contact, and returns the resulting plan — WITHOUT sending anything and without mutating the campaign. ALWAYS run this before sendCampaign: audienceCount is who the segment matched, eligibleCount who would actually be addressed, and the two excluded* counters say why the rest dropped (no consent vs no contact address). A tiny eligibleCount usually means the consent register, not the segment, is the problem. Note the response carries every eligible recipient’s raw contact (email address or phone number), so only call it when you actually need the recipient list. 404s for an unknown campaign.

POST

campaigns

{id}

dry-run

Error

A valid request URL is required to generate request examples

{
  "channel": "email",
  "audienceCount": 42,
  "eligibleCount": 31,
  "excludedNoConsentCount": 8,
  "excludedNoContactCount": 3,
  "recipients": [
    {
      "customerId": "cust-1",
      "contact": "camille.renard@example.com"
    }
  ]
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "<string>",
    "statusCode": 123,
    "fieldErrors": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123
  }
}

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

string

required

The server-minted campaign id (cmp-<uuid>) to act on.

Minimum string length: 1

Response

The consent-filtered recipient plan and the exclusion breakdown.

channel

enum<string>

required

Available options:

email,

sms

audienceCount

integer

required

Required range: 0 <= x <= 9007199254740991

eligibleCount

integer

required

Required range: 0 <= x <= 9007199254740991

excludedNoContactCount

integer

required

Required range: 0 <= x <= 9007199254740991

recipients

object[]

required

Show child attributes

Get a campaign by id (campagne)Send a campaign to its consented audience (campagne, relance)

Ventes & encaissement

Catalogue & stock

Finance

Clients & fidélité

Marketing & promotions

Services

Système

Other

Preview a campaign's recipients without sending (campagne, relance)

Authorizations

Path Parameters

Response