Delete a coupon template

DELETE

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

Permanently deletes a coupon template and its pass template. Returns the deleted template.

Good to know

• Deletion is permanent. This call deletes the template only: it does not delete the coupons already sent one by one, unlike DELETE /coupons/{id}/passes/{instanceId} on a multiple-instance template.

Request

path parameters

• id string required
  ID of the coupon template to delete.

header parameters

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

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
• 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

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

503

PASS_BUILDER_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