Disable a carrier for a load's lane
Mark a carrier as ineligible for the given load’s origin->destination lane. Resolves the load’s pickup/delivery, finds or creates the matching CarrierLanePreferenceH3, and flips it to is_active=False (preference_type is left untouched on existing rows). Search paths already filter on is_active=True, so the disable takes effect immediately, and ingestion will never flip an admin-disabled row back to active. Admin-only — requires OWNER or ADMIN role on the organization.
Authentication: Bearer token required.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
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
Load id (accepts prefixed or raw UUID)
Response
Minimal response for a toggled lane preference.
Only the fields actually stored on CarrierLanePreferenceH3 are
surfaced. Origin/destination city+state live on the related Lane row
and are intentionally not included here to avoid advertising fields we
would never populate without a join. Clients that need lane geography
can resolve it via lane_id.
True when a fresh disabled row was created; False if an existing row was flipped inactive