Aller au contenu principal

Mettre à jour des clients en masse

PATCH

https://api-v2.test.eldowallet.fr/clients/bulk

La réponse est une opération en masse : suivez son statut et ses résultats avec GET /bulk-operations/{operationId}.

À retenir
  • Jusqu'à 5 000 clients par requête ; chaque élément contient l'id du client et est traité comme un PATCH /clients/{id} (webhook client.updated). Avec forceSync: true, le traitement est synchrone, limité à moins de 1 000 éléments (sinon 400 SYNC_EXECUTION_NOT_ALLOWED). webhookUrl est appelée à la fin de l'opération.

Requête​

header parameters
  • x-lang string
    Langue des messages d'erreur et des textes renvoyés : `fr` ou `en`.
    enum: en, frdefault: "en"
Body application/json required
  • webhookUrl string
    URL de webhook facultative, appelée à la fin de l'opération. En-têtes d'authentification : ajoutez `#headers=Authorization:Bearer%20token` à l'URL.
    example: https://example.com/webhook#headers=Authorization:Bearer%20token
  • forceSync boolean
    Exécute l'opération de manière synchrone (moins de 1 000 éléments). Si la valeur est `true` et que la requête contient 1 000 éléments ou plus, elle est rejetée.
    default: false
  • items object[] required
    Liste des clients à mettre à jour.
    • id string required
      Identifiant du client.
      example: 507f1f77bcf86cd799439011
    • firstName stringminLength: 2maxLength: 100
    • lastName stringminLength: 2maxLength: 100
    • email string <email>
    • phoneNumber string
    • barcode string
    • renewalDate string <date-time>
    • birthDate string <date-time>
    • admissionDate string <date-time>
    • clientType string
    • gain number
    • companyName string
    • source stringenum: CRM, INTERNAL, EXTERNAL
    • sendCard boolean

Réponses​

Schéma application/json
  • operationId string required
    Identifiant unique de l'opération en masse.
    example: 507f1f77bcf86cd799439011
  • totalItems number required
    Nombre total d'éléments de l'opération.
    example: 100
  • successCount number required
    Nombre d'éléments traités avec succès.
    example: 95
  • failureCount number required
    Nombre d'éléments en échec.
    example: 5
  • status string required
    Current status of the operation
    enum: pending, processing, completed, failedexample: pending
    • operationErrors object[]
      Liste des erreurs des éléments en échec.
      • itemId string required
        Identifiant de l'élément en échec.
        example: 507f1f77bcf86cd799439011
      • message string required
        Message d'erreur.
        example: Client not found
      • code string
        Code d'erreur, s'il est disponible.
        example: 404:MODEL_NOT_FOUND
    • results object[]
      Liste des résultats des éléments traités avec succès.
      • itemId string required
        Identifiant de l'élément.
        example: 507f1f77bcf86cd799439011
      • result object
        Données du résultat.
    • createdAt string <date-time> required
      Date et heure de création de l'opération.
      example: 2024-01-01T00:00:00.000Z
    • completedAt string <date-time>
      Date et heure de fin de l'opération.
      example: 2024-01-01T00:05:00.000Z

    Les nouveautés de l'API, une fois par mois

    Nouveaux endpoints, changements à prévoir, guides et cas d'usage. Pas de spam, désinscription en un clic.

    Signaler un problème technique

    Une erreur de l’API, un pass qui ne se met pas à jour, un e-mail qui n’arrive pas ? Décrivez le problème : notre équipe technique vous répond.

    Pour une réponse rapide, indiquez :

    • La méthode et l’endpoint (ex. POST /clients)
    • Le code d’erreur renvoyé (errorCode) et le corps envoyé
    • La date et l’heure de l’appel
    • Les identifiants concernés (client, modèle, pass)

    N’y mettez jamais de jeton d’API ni de mot de passe.

    Assistant IA

    Beta

    Chargement…

    Réponses générées par IA (Claude) : vérifiez les points importants.

    Connectez-vous pour utiliser l'assistant