Bulk update clients

PATCH

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

Returns a bulk operation: track its status and results with GET /bulk-operations/{operationId}.

Good to know

• Up to 5,000 clients per request; each item carries the client id and is processed like PATCH /clients/{id} (client.updated webhook). With forceSync: true, processing is synchronous, limited to fewer than 1,000 items (otherwise 400 SYNC_EXECUTION_NOT_ALLOWED). webhookUrl is called when the operation completes.

Request

header parameters

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

Body application/json required

• webhookUrl string
  Optional webhook URL to receive notification when operation completes. Auth headers: append #headers=Authorization:Bearer%20token
  example: https://example.com/webhook#headers=Authorization:Bearer%20token
• forceSync boolean
  Execute synchronously (max 1000 items). If true and items >= 1000, request is rejected.
  default: false
• items object[] required
  Array of clients to update
  • id string required
    Client ID
    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

Responses

200

Schema application/json

• operationId string required
  Unique identifier for the bulk operation
  example: 507f1f77bcf86cd799439011
• totalItems number required
  Total number of items in the operation
  example: 100
• successCount number required
  Number of successfully processed items
  example: 95
• failureCount number required
  Number of failed items
  example: 5
• status string required
  Current status of the operation
  enum: pending, processing, completed, failedexample: pending
• operationErrors object[]
  Array of errors for failed items
  • itemId string required
    ID of the item that failed
    example: 507f1f77bcf86cd799439011
  • message string required
    Error message
    example: Client not found
  • code string
    Error code if available
    example: 404:MODEL_NOT_FOUND
• results object[]
  Array of results for successful items
  • itemId string required
    ID of the item
    example: 507f1f77bcf86cd799439011
  • result object
    Result data
• createdAt string <date-time> required
  Timestamp when the operation was created
  example: 2024-01-01T00:00:00.000Z
• completedAt string <date-time>
  Timestamp when the operation was completed
  example: 2024-01-01T00:05:00.000Z

400

VALIDATION_ERROR · INVALID_JSON

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

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

409

EMAIL_ALREADY_EXISTS · BARCODE_ALREADY_EXISTS

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