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
      • POSTCreate a carrier
      • POSTBatch create carriers
      • GETList carriers
      • GETGet a carrier
      • PATCHUpdate a carrier
      • POSTRe-enable a previously disabled carrier
      • POSTDisable a carrier organization-wide
LogoLogo
SupportDashboard
EndpointsCarriers

Disable a carrier organization-wide

POST
/carriers/:carrier_id/disable
POST
/api/v1/carriers/:carrier_id/disable
$curl -X POST https://tryenvoy.ai/api/v1/carriers/carrier_id/disable \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "reason": "pause_on_lane"
>}'
1{
2  "id": "car_3f2504e0-4f89-11d3-9a0c-0305e82c3301",
3  "name": "Swift Logistics",
4  "mc_number": "MC123456",
5  "dot_number": "DOT987654",
6  "email": "[email protected]",
7  "phone": "+1-555-123-4567",
8  "dispatcher_name": "Jane Doe",
9  "dispatcher_phone": "+1-555-765-4321",
10  "dispatcher_email": "[email protected]",
11  "is_active": false,
12  "provider": "EnvoyAI",
13  "ingestion_method": "manual",
14  "equipment_types": [
15    "VAN",
16    "REEFER"
17  ],
18  "insurance_expiration": "2024-12-31T23:59:59Z",
19  "w9_on_file": true,
20  "authorized_for_hire": true,
21  "on_time_pickup_pct": 92.5,
22  "on_time_delivery_pct": 89.7,
23  "tracking_compliance_pct": 95.3,
24  "avg_response_time_min": 15.2,
25  "total_loads_hauled": 1245,
26  "is_onboarded": true,
27  "carrier_rep_user_id": "usr_7e57d004-2b97-0e7a-b45f-5387367791cd",
28  "carrier_rep_name": "John Smith",
29  "carrier_rep_email": "[email protected]",
30  "is_verified": true,
31  "verified_date": "2023-11-01T10:00:00Z",
32  "created_at": "2020-05-20T08:30:00Z",
33  "updated_at": "2024-04-10T14:45:00Z"
34}
Mark this carrier as ineligible for any Ellie workflow on this org. Requires a human-readable reason; an audit-log row capturing the actor, reason, and timestamp is written in the same transaction. Idempotent: calling this when the carrier is already disabled returns the current row unchanged and writes no audit entry. Admin-only — requires OWNER or ADMIN role on the organization. **Authentication:** Bearer token required.
Was this page helpful?
Previous

List a carrier's lane preferences

Next
Built with

Mark this carrier as ineligible for any Ellie workflow on this org. Requires a human-readable reason; an audit-log row capturing the actor, reason, and timestamp is written in the same transaction. Idempotent: calling this when the carrier is already disabled returns the current row unchanged and writes no audit entry. 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.
reasonenumRequired

Constrained reason code; see AuditLogReason for the value set.

reason_notestring or nullOptional<=2000 characters

Response

Successful Response
idstringformat: "^car_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
namestring
mc_numberstring or null
dot_numberstring or null
emailstring or null
phonestring or null
dispatcher_namestring or null
dispatcher_phonestring or null
dispatcher_emailstring or null
is_activebooleanDefaults to true
providerstring or null
ingestion_methodstring or null
equipment_typeslist of enums or null
insurance_expirationdatetime or null
w9_on_fileboolean or null
authorized_for_hireboolean or null
on_time_pickup_pctdouble or null
on_time_delivery_pctdouble or null
tracking_compliance_pctdouble or null
avg_response_time_mindouble or null
total_loads_hauledinteger or null
is_onboardedbooleanDefaults to false
carrier_rep_user_idstringformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
carrier_rep_namestring or null
carrier_rep_emailstring or null
is_verifiedbooleanDefaults to false
verified_datedatetime or null
created_atdatetime or null
updated_atdatetime or null

Errors

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