Export clients to CSV

POST

https://api-v2.test.eldowallet.fr/csv-operations/export-csv

Runs in the background: the response is a CSV operation whose progress you can follow with GET /csv-operations.

Good to know

• Exports every client of the wallet. When the operation reaches SUCCESS, fileLink holds the URL of the CSV file (UTF-8 with BOM) and the user who requested the export receives an email with the link; on error the status becomes FAILURE. Columns: _id, firstName, lastName, email, renewalDate, source, phoneNumber, wallet, barcode, admissionDate, createdAt, birthDate, status, devices, type, shortlink, gain, communicationPreferences.

Request

header parameters

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

Responses

201

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
• operationType string requiredenum: IMPORT, EXPORT
• startTime string <date-time> required
• endTime string <date-time>
• numRecords number
• numDuplicates number required
• numInvalid number required
• numValid number required
• numSuccessful number required
• fileName string
• fileLink string
• invalidCsvFileLink string
• customerCsvFileLink string
• validCustomersCsv string
• sendNotificationsToCustomers boolean required
• status string requiredenum: SUCCESS, FAILURE, PENDING, CLOSE, INCOMPLETED, DOWNLOADED
• _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

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