Toggle a lane preference’s is_active flag

PATCH

/carriers/:carrier_id/lane-preferences/:preference_id

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.

AuthorizationBearer

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

carrier_idstringRequiredformat: "uuid"

preference_idstringRequiredformat: "uuid"

This endpoint expects an object.

is_activebooleanRequired

Whether this carrier should be eligible on this lane

Successful Response

idstringformat: "uuid"

carrier_idstringformat: "uuid"

lane_idstringformat: "uuid"

is_activeboolean

preference_typestring

updated_atdatetime or null

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

$	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
>	}'