Get the communication preferences of a client

GET

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

Returns a client's communication preferences: allowed channels (email, sms, notification) per notification type, consent to informative and commercial push notifications, and the link to the public page where the client manages their own preferences (consentLink).

Good to know

• A notification type or channel that was never set counts as allowed (true), as do pushInformativeEnabled and pushCommercialEnabled. consentLink is absent when the client has no loyalty card.

Request

path parameters

• clientId string required
  Client ID (24-character hexadecimal ObjectId).

header parameters

• x-lang string
  Language for responses
  enum: en, frdefault: "en"

Responses

200

Schema 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
  Public, no-login consent-management page URL ('/consent/:token') the client uses to manage their own preferences. Absent if the client has no storecard pass.

401

UNAUTHORIZED

Schema 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

Schema 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

Schema 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

Schema 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