CLIENT
Bulk Import

Validate CSV File

Validate a CSV file without importing. Useful for checking data before actual import.

post/internal/api/clients/bulk-import/validate

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Request body multipart/form-data

filestring binary required

CSV file to validate

Response

Successful Response

totalinteger required

Total number of rows processed

successfulinteger required

Number of successfully imported clients

failedinteger required

Number of failed imports

Example response

{
  "errors": [
    {
      "error": "Invalid email format",
      "external_id": "RJ003",
      "row": 3
    }
  ],
  "failed": 2,
  "imported_clients": [
    {
      "external_id": "RJ001",
      "full_name": "John Doe",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "readable_id": "CL-000001"
    }
  ],
  "successful": 8,
  "total": 10
}

Changes

No recorded changes to this operation across all 1 revision of this API.