For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDashboard
GuidesAPI Reference
GuidesAPI Reference
  • Endpoints
      • GETList a carrier's lane preferences
      • PATCHToggle a lane preference's is_active flag
      • POSTRestrict a carrier on a specific lane
      • POSTRe-enable a carrier on a previously restricted lane
      • POSTDisable a carrier for a load's lane
LogoLogo
SupportDashboard
EndpointsLane Preferences

List a carrier's lane preferences

GET
/carriers/:carrier_id/lane-preferences
GET
/api/v1/carriers/:carrier_id/lane-preferences
$curl https://tryenvoy.ai/api/v1/carriers/carrier_id/lane-preferences \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1[
2  {
3    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4    "carrier_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
5    "lane_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
6    "is_active": true,
7    "preference_type": "primary",
8    "updated_at": "2024-01-15T09:30:00Z",
9    "origin_city": "Chicago",
10    "origin_state": "IL",
11    "destination_city": "Dallas",
12    "destination_state": "TX"
13  }
14]
Return every CarrierLanePreferenceH3 row for the given carrier, joined with its Lane row so origin/destination city+state come back inline. Filter with `is_active=false` to pull only disabled lanes (the re-enable surface on the carrier detail page). Admin-only — the response is what the PATCH toggle endpoint modifies, so viewing is gated the same way as editing. **Authentication:** Bearer token required.
Was this page helpful?
Previous

Toggle a lane preference’s is_active flag

Next
Built with

Return every CarrierLanePreferenceH3 row for the given carrier, joined with its Lane row so origin/destination city+state come back inline. Filter with is_active=false to pull only disabled lanes (the re-enable surface on the carrier detail page). Admin-only — the response is what the PATCH toggle endpoint modifies, so viewing is gated the same way as editing.

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

Query parameters

is_activeboolean or nullOptional

Filter by is_active (omit for all)

limitintegerOptional1-2000Defaults to 500

Max rows returned (1..2000, default 500)

Response

Successful Response
idstringformat: "uuid"
carrier_idstringformat: "uuid"
lane_idstringformat: "uuid"
is_activeboolean
preference_typestring
updated_atdatetime or null
origin_citystring or null
origin_statestring or null
destination_citystring or null
destination_statestring or null

Errors

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