Skip to navigation
EndpointsAPI

Validate lane preferences without saving

Dry run of POST /v1/carriers/lane-preferences/batch: per-item errors and warnings, nothing written. Takes the same body; each record is checked on its own.

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
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.
carrier_lane_preferenceslist of objectsRequired

Lane preferences in the /v1/carriers/lane-preferences/batch shape

Response

Successful Response
validboolean

True when every item is valid (warnings allowed)

datalist of objects
summaryobject

Counts for a dry run: how many items would be applied, rejected, or applied with warnings.

Errors

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