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.

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

AuthorizationBearer

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

Path parameters

carrier_idstringRequiredformat: "uuid"

Headers

X-Organization-IDstring or nullOptional

Request

This endpoint expects an object.

load_idstringRequiredformat: "uuid"

Load id (accepts prefixed or raw UUID)

Response

Successful Response

preferenceobject

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.

createdboolean

True when a fresh disabled row was created; False if an existing row was flipped inactive

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

$	curl -X POST https://tryenvoy.ai/api/v1/carriers/carrier_id/lane-preferences/disable-for-load \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"load_id": "load_987654321"
>	}'

1	{
2	"preference": {
3	"id": "pref_123abc456def",
4	"carrier_id": "carrier_789xyz",
5	"lane_id": "lane_456def789abc",
6	"is_active": false,
7	"preference_type": "admin_disabled",
8	"updated_at": "2024-01-15T09:30:00Z"
9	},
10	"created": false
11	}