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

Toggle a lane preference’s is_active flag

PATCH
/carriers/:carrier_id/lane-preferences/:preference_id
PATCH
/api/v1/carriers/:carrier_id/lane-preferences/:preference_id
$curl -X PATCH https://tryenvoy.ai/api/v1/carriers/carrier_id/lane-preferences/preference_id \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "is_active": true
>}'
1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "carrier_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
4  "lane_id": "1c9e6679-7425-40de-944b-e07fc1f90b12",
5  "is_active": true,
6  "preference_type": "primary",
7  "updated_at": "2024-01-15T09:30:00Z"
8}

Partial update for a CarrierLanePreferenceH3. Today only is_active is exposed. Admin-only — requires OWNER or ADMIN role on the organization.

Authentication: Bearer token required.

Was this page helpful?
Previous

Restrict a carrier on a specific lane

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

carrier_idstringRequiredformat: "uuid"
preference_idstringRequiredformat: "uuid"

Headers

X-Organization-IDstring or nullOptional

Request

This endpoint expects an object.
is_activebooleanRequired
Whether this carrier should be eligible on this lane

Response

Successful Response
idstringformat: "uuid"
carrier_idstringformat: "uuid"
lane_idstringformat: "uuid"
is_activeboolean
preference_typestring
updated_atdatetime or null

Errors

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