Skip to main content

Create a coupon template

POST

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

Creates a coupon template in your wallet along with its pass template. Send the request as multipart/form-data with the strip image (strip). Returns the created template; then use POST /coupons/{id}/passes/send to send coupons to your clients.

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​

header parameters
  • x-lang string
    Language for responses
    enum: en, frdefault: "en"
Body multipart/form-data required
  • strip string <binary> required
  • barcodeFormat string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
  • name string required
  • description string required
  • 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 required
    • 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
  • 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
  • barcodeFormat string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
  • name string required
  • description string required
  • promoCode string
  • value string
  • expirationDate string <date-time>
  • isMultipleInstance boolean required
  • isWelcomeCoupon boolean required
  • status string requiredenum: ACTIVE, INACTIVE, EXPIRED
  • source string requiredenum: INTERNAL, EXTERNAL, CRM, ALL
  • colors object required
    • labelColor string required
    • backgroundColor string required
    • foregroundColor string required
  • strip string
  • emailSubscriptionMessage string
  • subscriptionMessage string
  • security object
    • oneTimeToUseJwtLink boolean required
    • disableIOSPassSharing boolean
    • enableOneTimeUse boolean
    • disableMultipleHolders boolean
    • enableSecurityAnimation boolean
    • enableRotatingBarcode boolean
  • valueLabel string requiredenum: VALUE, AMOUNT, PRESTATION
  • iosHeader object
    • labelEnum string requiredenum: FULLNAME, CUSTOM_TEXT, INACTIVE
    • valueEnum string requiredenum: FULLNAME, CUSTOM_TEXT, INACTIVE
    • customLabel string
    • customValue string
  • passBuilderPassTemplateId string
  • _id string required
  • createdAt string <date-time> required
  • updatedAt string <date-time> required

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