Skip to main content

Update a coupon template

PATCH

https://api-v2.test.eldowallet.fr/coupons/:id

Updates a coupon template and its pass template; coupons already sent are updated accordingly. Accepts application/json or multipart/form-data (to replace the strip image). Warning: if you do not send expirationDate, the template's expiration date is cleared.

Good to know
  • Body is multipart/form-data: nested objects (colors, security, locations…) are sent as a JSON string, booleans as "true"/"false". Images: PNG or JPEG, 1 KB to 5 MB.

Request​

path parameters
  • id string required
    ID of the coupon template to update.
header parameters
  • x-lang string
    Language for responses
    enum: en, frdefault: "en"
Body multipart/form-data required
  • strip string <binary>
  • barcodeFormat stringenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
  • name string
  • description string
  • promoCode string
  • value string
  • expirationDate string <date-time>
  • isMultipleInstance boolean
  • isWelcomeCoupon boolean
  • status stringenum: ACTIVE, INACTIVE, EXPIRED
  • source stringenum: INTERNAL, EXTERNAL, CRM, ALL
  • valueLabel stringenum: VALUE, AMOUNT, PRESTATION
  • colors object
    • backgroundColor string required
    • labelColor string required
    • foregroundColor string required
  • emailSubscriptionMessage string
  • subscriptionMessage string
  • security object
    • oneTimeToUseJwtLink boolean
    • disableIOSPassSharing boolean
    • enableOneTimeUse boolean
    • disableMultipleHolders boolean
    • enableSecurityAnimation boolean
    • enableRotatingBarcode boolean
  • iosHeader object
    • labelEnum string requiredenum: FULLNAME, CUSTOM_TEXT, INACTIVE
    • valueEnum string requiredenum: FULLNAME, CUSTOM_TEXT, INACTIVE
    • customLabel string
    • customValue string
Body application/json required
  • strip string <binary>
  • barcodeFormat stringenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
  • name string
  • description string
  • promoCode string
  • value string
  • expirationDate string <date-time>
  • isMultipleInstance boolean
  • isWelcomeCoupon boolean
  • status stringenum: ACTIVE, INACTIVE, EXPIRED
  • source stringenum: INTERNAL, EXTERNAL, CRM, ALL
  • valueLabel stringenum: VALUE, AMOUNT, PRESTATION
  • colors object
    • backgroundColor string required
    • labelColor string required
    • foregroundColor string required
  • emailSubscriptionMessage string
  • subscriptionMessage string
  • security object
    • oneTimeToUseJwtLink boolean
    • disableIOSPassSharing boolean
    • enableOneTimeUse boolean
    • disableMultipleHolders boolean
    • enableSecurityAnimation boolean
    • enableRotatingBarcode boolean
  • iosHeader object
    • labelEnum string requiredenum: FULLNAME, CUSTOM_TEXT, INACTIVE
    • valueEnum string requiredenum: FULLNAME, CUSTOM_TEXT, INACTIVE
    • customLabel string
    • customValue string

Responses​

Schema application/json

API news, once a month

New endpoints, upcoming changes, guides and use cases. No spam, one-click unsubscribe.

Report a technical problem

An API error, a pass that does not update, an email that does not arrive? Describe the problem: our technical team will answer.

For a fast answer, include:

  • The method and endpoint (e.g. POST /clients)
  • The error code returned (errorCode) and the body sent
  • The date and time of the call
  • The identifiers involved (customer, template, pass)

Never include an API token or a password.

AI assistant

Beta

Loading…

AI-generated answers (Claude): double-check important details.

Sign in to use the assistant