Mettre à jour les paramètres du wallet

PATCH

https://api-v2.test.eldowallet.fr/wallet-settings

Met à jour les paramètres d'envoi du wallet : canal de communication, configuration SMS ou e-mail, et règles d'envoi par type de notification. Seuls les champs envoyés sont modifiés ; renvoie les paramètres mis à jour.

À retenir

• communicationRules remplace toute la liste : envoyez toutes les règles (notificationType avec email, sms, notification). Passer communicationChannel à sms ou all exige une configuration SMS déjà enregistrée (smsConfig avec identifiants), sinon 400 SMS_CONFIG_REQUIRED : enregistrez d'abord smsConfig, puis changez de canal.

Requête

header parameters

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

Body application/json required

• apiKey string
  Clé d'API des paramètres du wallet.
• communicationChannel string
  Canal de communication préféré.
  enum: email, sms, all
• smsConfig object
  Configuration SMS.
  • smsTitle string required
    Titre (expéditeur) des SMS.
  • username string required
    Nom d'utilisateur du service SMS.
  • password string required
    Mot de passe du service SMS.
• emailConfig object
  Configuration e-mail.
  • type string required
    Type de service e-mail.
    default: "ses"
  • port number required
    Port du service e-mail.
  • auth object required
    Identifiants d'authentification du service e-mail.
    • user string required
      Nom d'utilisateur pour l'authentification e-mail.
    • pass string required
      Mot de passe pour l'authentification e-mail.
  • host string required
    Hôte du service e-mail.
• communicationRules object[]
  • 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

Réponses

200

Schéma application/json

• wallet oneOf required
  • Wallet
    • name string required
    • logo string required
    • icon string required
    • androidLogo string
    • displayIdentifiant boolean required
    • passBuilderPassTemplateId string
    • passBuilderBusinessId string
    • passBuilderToken string
    • identifier string required
    • identifierQr string required
    • address string
    • website string required
    • servicePhone string required
    • businessPhone string required
    • socialMedia object required
      • linkedin string
      • facebook string
      • instagram string
      • tiktok string
      • twitter string
      • youtube string
      • snapchat string
      • pinterest string
      • reddit string
      • whatsapp string
      • telegram string
    • additionalContacts object[] required
      • title string required
      • value string required
      • kind string requiredenum: URL, PHONE, EMAIL
    • termsAndConditions object required
      • type string requiredenum: PDF, URL, NONE
      • customUrl string
      • pdfUrl string
    • webHookUrl string required
    • rootDomain string required
    • timezone string
    • allowedPasses string[] requiredenum: ALL, EVENT_TICKET, TRANSIT, CINEMA, BOARDING_PASS, COUPON, GENERIC, STORE_CARD, OFFER, HOTEL
    • expiredCleanupEnabled boolean required
    • _id string required
    • createdAt string <date-time> required
    • updatedAt string <date-time> required
  • option 2
• apiKey string required
• communicationChannel string requiredenum: email, sms, all
• smsConfig object
  • smsTitle string required
  • username string required
  • password string required
• emailConfig object
  • type string requiredenum: SES, SMTP
  • port number required
  • auth object required
    • user string required
    • pass string required
  • host string required
• communicationRules 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
• _id string required
• createdAt string <date-time> required
• updatedAt string <date-time> required

400

VALIDATION_ERROR · INVALID_JSON · SMS_CONFIG_REQUIRED

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

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