Skip to navigation
EndpointsAPI

Import carrier CSV rows

CSV-specific carrier import. Requires name, at least one of MC or DOT, and the existing carrier contact requirement. Identity errors are returned per row.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Organization-IDstring or nullOptional
X-CSV-Import-IDstring or nullOptional

Browser-generated UUID correlating every chunk of one CSV import attempt

X-CSV-Chunk-Indexstring or nullOptional

1-based position of this chunk within the import

X-CSV-Chunk-Countstring or nullOptional
Total number of chunks in the import
Idempotency-KeystringOptional<=255 characters

A unique key (up to 255 printable ASCII characters, e.g. a UUID) that makes a retry of this request safe. Envoy stores the response for 24 hours; a retry with the same key and the same request returns it again with Idempotent-Replayed: true instead of running twice. The same key with a different request returns 422 idempotency_key_reused; while the first request is still running, 409 idempotency_key_in_progress. 5xx and 429 responses are not stored.

Request

This endpoint expects an object.
carrierslist of objectsRequired

Carrier CSV rows to create or update (max 1000)

Response

Successful Response
successboolean
totalinteger
successfulinteger
failedinteger
createdinteger
updatedinteger
resultslist of objects
processed_atdatetime
backend_duration_msdouble or nullOptional>=0
Server processing time for this CSV import chunk

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error