List marketing campaigns (campagne)

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

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

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

GET

campaigns

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

Response

Every campaign with its dispatch state, newest first.

string

required

Minimum string length: 1

name

string

required

Minimum string length: 1

channel

enum<string>

required

Available options:

email,

sms

segment

object

required

Show child attributes

status

enum<string>

required

Available options:

draft,

scheduled,

sending,

sent,

failed

audienceCount

integer

required

Required range: 0 <= x <= 9007199254740991

recipientCount

integer

required

Required range: 0 <= x <= 9007199254740991

sentCount

integer

required

Required range: 0 <= x <= 9007199254740991

failedCount

integer

required

Required range: 0 <= x <= 9007199254740991

createdAt

string<date-time>

required

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))$

updatedAt

string<date-time>

required

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))$

templateId

string

Minimum string length: 1

content

object

Show child attributes

couponBatchRef

string

Minimum string length: 1

scheduledAt

string<date-time>

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))$

Example:

[
  {
    "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"
  }
]

Deactivate a promotion rule Author a marketing campaign (campagne)

Ventes & encaissement

Catalogue & stock

Finance

Clients & fidélité

Marketing & promotions

Services

Système

Other

List marketing campaigns (campagne)

Authorizations

Response