Skip to main content

Update a transit template

PATCH

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

Updates a transit template; passes already installed are updated. Holders are notified according to the UPDATE_TRANSIT notification template. Accepts multipart/form-data (new strip image) or application/json.

Good to know
  • The wallet must have the TRANSIT pass type enabled.
  • 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
    Transit template ID (`_id`).
header parameters
  • x-lang string
    Language for responses
    enum: en, frdefault: "en"
Body multipart/form-data required
  • strip string <binary>
  • terms string
  • customerServiceNumber string
  • originStationCode string
  • originName string
  • destinationStationCode string
  • destinationName string
  • departureTime stringpattern: ^([01]\d|2[0-3]):([0-5]\d)(Z|([+-]([01]\d|2[0-3]):[0-5]\d))?$
  • arrivalTime stringpattern: ^([01]\d|2[0-3]):([0-5]\d)(Z|([+-]([01]\d|2[0-3]):[0-5]\d))?$
  • tarif string
  • details string
  • number number
  • type stringenum: Bus, Boat, Train, Air, Generic, Tram
  • gateName stringenum: N_CABINE, N_VOYAGE, PLAQUE
  • seatName stringenum: N_CABINE, N_VOYAGE, PLAQUE
  • emailSubscriptionMessage string
  • subscriptionMessage string
  • barcodeFormat stringenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
  • locations object[]
    • latitude number required
    • longitude number required
  • colors object
    • backgroundColor string required
    • labelColor string required
    • foregroundColor string required
  • security object
    • enableOneTimeUse boolean
    • disableIOSPassSharing boolean
    • disablePassLinkSharing boolean
    • disableMultipleHolders boolean
    • enableSecurityAnimation boolean
    • enableRotatingBarcode boolean
  • displayOptions object
    • hideTarif boolean
    • hideStationCodes boolean
    • hideTripNumber boolean
  • iosHeader object
    • labelEnum string requiredenum: FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE
    • valueEnum string requiredenum: FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE
    • customLabel string
    • customValue string
Body application/json required
  • strip string <binary>
  • terms string
  • customerServiceNumber string
  • originStationCode string
  • originName string
  • destinationStationCode string
  • destinationName string
  • departureTime stringpattern: ^([01]\d|2[0-3]):([0-5]\d)(Z|([+-]([01]\d|2[0-3]):[0-5]\d))?$
  • arrivalTime stringpattern: ^([01]\d|2[0-3]):([0-5]\d)(Z|([+-]([01]\d|2[0-3]):[0-5]\d))?$
  • tarif string
  • details string
  • number number
  • type stringenum: Bus, Boat, Train, Air, Generic, Tram
  • gateName stringenum: N_CABINE, N_VOYAGE, PLAQUE
  • seatName stringenum: N_CABINE, N_VOYAGE, PLAQUE
  • emailSubscriptionMessage string
  • subscriptionMessage string
  • barcodeFormat stringenum: AZTEC, CODE_128, PDF_417, QR_CODE, NONE
  • locations object[]
    • latitude number required
    • longitude number required
  • colors object
    • backgroundColor string required
    • labelColor string required
    • foregroundColor string required
  • security object
    • enableOneTimeUse boolean
    • disableIOSPassSharing boolean
    • disablePassLinkSharing boolean
    • disableMultipleHolders boolean
    • enableSecurityAnimation boolean
    • enableRotatingBarcode boolean
  • displayOptions object
    • hideTarif boolean
    • hideStationCodes boolean
    • hideTripNumber boolean
  • iosHeader object
    • labelEnum string requiredenum: FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE
    • valueEnum string requiredenum: FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, 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
  • terms string required
  • emailSubscriptionMessage string
  • subscriptionMessage string
  • locations object[]
    • longitude number
    • latitude number
    • relevantName string
    • relevantAddress string
  • colors object required
    • labelColor string required
    • backgroundColor string required
    • foregroundColor string required
  • strip string
  • customerServiceNumber string
  • originStationCode string required
  • originName string required
  • destinationStationCode string required
  • destinationName string required
  • departureTime string required
  • arrivalTime string required
  • tarif string
  • details string required
  • number string required
  • type string requiredenum: Bus, Boat, Train, Air, Generic, Tram
  • gateName stringenum: N_CABINE, N_VOYAGE, PLAQUE
  • seatName stringenum: N_CABINE, N_VOYAGE, PLAQUE
  • security object
    • enableOneTimeUse boolean
    • disableIOSPassSharing boolean
    • disablePassLinkSharing boolean
    • disableMultipleHolders boolean
    • enableSecurityAnimation boolean
    • enableRotatingBarcode boolean
  • passBuilderPassTemplateId string
  • customBackFields string[]
    Template-level back field definitions (key + label + type). Per-pass values live on the Pass document.
  • displayOptions object
    • hideTarif boolean
    • hideStationCodes boolean
    • hideTripNumber boolean
  • iosHeader object
    • labelEnum string requiredenum: FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE
    • valueEnum string requiredenum: FULLNAME, CUSTOM_TEXT, TRIP_NUMBER, INACTIVE
    • customLabel string
    • customValue 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