Skip to main content

Create an event

POST

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

Creates an event, i.e. the ticket template (name, dates, locations, colours, strip image) shared by all its passes. The request is sent as multipart/form-data and returns the created event.

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.
  • Uses barcodeType (not barcodeFormat as in coupons/transits/hotels). Nested objects (date, locations, colors, security) are sent as JSON strings in multipart. date.startDate must be before endDate and doorOpeningHour before startDate. price is 0..9999.99. contactPhone must be E.164-like (+...).

Request​

header parameters
  • x-lang string
    Language for responses
    enum: en, frdefault: "en"
Body multipart/form-data required
  • strip string <binary> required
  • barcodeType string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
  • name string required
  • locations object[]
    • longitude number required
    • latitude number required
    • address string requiredmaxLength: 500
    • locationName string requiredmaxLength: 500
  • date object
    • startDate string <date-time>
    • endDate string <date-time>
    • doorOpeningHour string <date-time>
  • price numbermin: 0max: 9999.99
  • gainUnit stringenum: NONE, EURO, USD, MAD, POINTS
  • description string
  • terms string
  • subscriptionMessage string
  • emailSubscriptionMessage string
  • contactPhone stringpattern: ^\+(?:[0-9] ?){6,14}[0-9]$
  • email string <email>
  • website string <uri>
  • colors object required
    • backgroundColor string required
    • labelColor string required
    • foregroundColor string required
  • security object
    • enableOneTimeUse boolean
    • disableIOSPassSharing boolean
    • disablePassLinkSharing boolean
    • disableMultipleHolders boolean
    • enableSecurityAnimation boolean
    • enableRotatingBarcode boolean
  • PKTextAlignmentLeft stringenum: CHAIR, ACCESS, PRICE, ZONE, INACTIVE
  • PKTextAlignmentCenter stringenum: ROW, INACTIVE
  • PKTextAlignmentRight stringenum: INACTIVE, TYPE, SEAT, PLACE, ARMCHAIR, LOCATION, PORT

Responses​

Schema application/json
  • status string requiredenum: PENDING, ACTIF, ENDEDdefault: "PENDING"
    • 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
    • barcodeType string requiredenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
    • name string required
    • locations object[] required
      • longitude number
      • latitude number
      • address string
      • locationName string
    • date object
      • startDate string <date-time>
      • endDate string <date-time>
      • doorOpeningHour string <date-time>
    • price number
    • gainUnit stringenum: NONE, EURO, USD, MAD, POINTS
    • description string
    • terms string
    • subscriptionMessage string required
    • emailSubscriptionMessage string required
    • contactPhone string
    • email string
    • website string
    • colors object required
      • labelColor string required
      • backgroundColor string required
      • foregroundColor string required
    • security object
      • enableOneTimeUse boolean
      • disableIOSPassSharing boolean
      • disablePassLinkSharing boolean
      • disableMultipleHolders boolean
      • enableSecurityAnimation boolean
      • enableRotatingBarcode boolean
    • passBuilderPassTemplateId string
    • strip string
    • PKTextAlignmentLeft stringenum: CHAIR, ACCESS, PRICE, ZONE, INACTIVE
    • PKTextAlignmentCenter stringenum: ROW, INACTIVE
    • PKTextAlignmentRight stringenum: INACTIVE, TYPE, SEAT, PLACE, ARMCHAIR, LOCATION, PORT
    • _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