Update a push notification

PUT

https://api-v2.test.eldowallet.fr/push-notifications/:id

Replaces a push notification's content, target, category or schedule and recomputes its recipients. Use it to change a scheduled notification before it is sent. Returns the updated notification.

Good to know

• scheduleAt is required when type is SCHEDULED.
• Recipients are recomputed from the request body: send target, clients, defaultTitle and defaultMessage again as for a creation, or the omitted titles and messages are left empty. For an INSTANT notification, scheduleAt is reset to now, so it is sent on the next dispatch run. The PUSH credit and 10-second gap checks apply as on creation.

Request

path parameters

• id string required
  Push notification ID (24-character hexadecimal ObjectId).

header parameters

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

Body application/json required

• defaultTitle string
• defaultMessage string
• target stringenum: ALL, SPECIFIC
• type stringenum: INSTANT, SCHEDULED
• category string
  Informative vs. commercial classification — required so the client's consent (pushInformativeEnabled/pushCommercialEnabled) can be checked at send time.
  enum: INFORMATIVE, COMMERCIAL
• clients object[]
  • id string required
  • title string
  • message string
• scheduleAt string <date-time>

Responses

200

Schema 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
• defaultTitle string required
• defaultMessage string required
• target string requiredenum: ALL, SPECIFIC
• type string requiredenum: INSTANT, SCHEDULED
• clients object[] required
  • id oneOf required
    • Client
      • wallet string
      • clientType oneOf
        • ClientType
          • storeCard oneOf required
          • name string required
          • isDefault boolean required
          • _id string required
          • createdAt string <date-time> required
          • updatedAt string <date-time> required
        • option 2
      • source string requiredenum: CRM, INTERNAL, EXTERNAL
      • barcode string
      • firstName string required
      • lastName string required
      • email string
      • companyName string
      • renewalDate string <date-time>
      • phoneNumber string
      • birthDate string <date-time>
      • admissionDate string <date-time>
      • gain number
      • gainHistory object[]
        • gain number required
        • date string <date-time> required
      • communicationPreferences object[]
        Per-event, per-channel communication preference overrides for this client (GDPR consent management). Same shape as `WalletSetting.communicationRules` — reused rather than duplicated. No entry for a given notificationType means enabled, mirroring `isCommunicationRuleEnabled`'s existing semantics. Change history is intentionally NOT embedded here — see `CommunicationPreferenceLog` — to keep this frequently-read document small.
        • 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
        Opt-out of manager-created "standard" push campaigns classified as informative.
      • pushCommercialEnabled boolean
        Opt-out of manager-created "standard" push campaigns classified as commercial.
      • _id string required
      • createdAt string <date-time> required
      • updatedAt string <date-time> required
    • option 2
  • passBuilderPassId string
  • title string
  • message string
• category string
  Informative/commercial classification, used to gate against the recipient's `Client.pushInformativeEnabled`/`pushCommercialEnabled`.
  enum: INFORMATIVE, COMMERCIAL
• scheduleAt string <date-time>
• sentAt string <date-time>
• _id string required
• createdAt string <date-time> required
• updatedAt string <date-time> required

400

VALIDATION_ERROR · INVALID_JSON · INSUFFICIENT_CREDIT

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

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

409

PUSH_NOTIFICATION_SCHEDULE_CONFLICT

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