Obtenir les préférences de communication d'un client

GET

https://api-v2.test.eldowallet.fr/clients/:clientId/communication-preferences

Renvoie les préférences de communication d'un client : canaux autorisés (email, sms, notification) par type de notification, consentement aux notifications push informatives et commerciales, et lien vers la page publique où le client gère lui-même ses préférences (consentLink).

À retenir

• Un type de notification ou un canal jamais réglé est considéré comme autorisé (true), de même que pushInformativeEnabled et pushCommercialEnabled. consentLink est absent si le client n'a pas de carte de fidélité.

Requête

path parameters

• clientId string required
  Identifiant du client (ObjectId de 24 caractères hexadécimaux).

header parameters

• x-lang string
  Langue des messages d'erreur et des textes renvoyés : `fr` ou `en`.
  enum: en, frdefault: "en"

Réponses

200

Schéma application/json

• communicationPreferences object[] required
  • notificationType string requiredenum: NEW_LOYALTY, UPDATE_LOYALTY, REMINDER_LOYALTY, EARNINGS_UPDATE, NEW_COMMUNICATION, EXPIRED_COMMUNICATION, NEW_EVENT, UPDATE_EVENT, NEW_COUPON, UPDATE_COUPON, WELCOME_INTERNAL_CLIENTS, WELCOME_CRM_CLIENTS, WELCOME_EXTERNAL_CLIENTS, WELCOME_COUPON, EXPIRED_COUPON, TRANSIT_TICKET, UPDATE_TRANSIT, HOTEL_RESERVATION, UPDATE_HOTEL_RESERVATION, CINEMA_TICKET
  • sms boolean required
  • email boolean required
  • notification boolean required
• pushInformativeEnabled boolean required
• pushCommercialEnabled boolean required
• consentLink string
  URL de la page publique de gestion des consentements (`/consent/:token`), sans connexion, sur laquelle le client gère lui-même ses préférences. Absente si le client n'a pas de carte de fidélité.

401

UNAUTHORIZED

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

404

MODEL_NOT_FOUND

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schéma application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email