Error

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": {
    "message": "<string>",
    "statusCode": 123
  }
}

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

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

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

Marketing

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.

POST

campaigns

{id}

send

Error

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": {
    "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 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

Show child attributes

sentCount

integer

required

Required range: 0 <= x <= 9007199254740991

failedCount

integer

required

Required range: 0 <= x <= 9007199254740991

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

Ventes & encaissement

Catalogue & stock

Finance

Clients & fidélité

Marketing & promotions

Services

Système

Other

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

Authorizations

Path Parameters

Response