Skip to main content
POST
/
v1
/
import-batches
Create an import batch
curl --request POST \
  --url http://localhost:3001/v1/import-batches \
  --header 'Content-Type: application/json' \
  --data '
{
  "importProfileId": "<string>",
  "originalFileName": "<string>",
  "fileContent": "<string>",
  "format": "csv",
  "fileContentBase64": "<string>",
  "fileHash": "<string>",
  "createdByUserId": "<string>",
  "contentType": "<string>"
}
'
{
  "batch": {
    "id": "<string>",
    "organizationId": "<string>",
    "importProfileId": "<string>",
    "sourceType": "<string>",
    "provider": "<string>",
    "integrationKey": "<string>",
    "originalFileName": "<string>",
    "fileStorageKey": "<string>",
    "fileHash": "<string>",
    "status": "<string>",
    "totalRows": 123,
    "validRows": 123,
    "warningRows": 123,
    "failedRows": 123,
    "createdByUserId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "auditEvents": [
      {
        "id": "<string>",
        "organizationId": "<string>",
        "paymentIntentId": "<string>",
        "caseId": "<string>",
        "rawRecordId": "<string>",
        "importBatchId": "<string>",
        "eventType": "<string>",
        "actor": "<string>",
        "payload": {},
        "message": "<string>",
        "occurredAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "duplicate": true
}

Headers

authorization
string
Minimum string length: 1
x-organization-id
string
Minimum string length: 1

Body

application/json
importProfileId
string
required
Minimum string length: 1
originalFileName
string
required
Minimum string length: 1
fileContent
string
required
Minimum string length: 1
format
enum<string>
default:csv
required
Available options:
csv
fileContentBase64
string
Minimum string length: 1
fileHash
string
Minimum string length: 1
createdByUserId
string
Minimum string length: 1
contentType
string
Minimum string length: 1

Response

Default Response

batch
ImportBatchDetail ยท object
required
duplicate
boolean
required