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

Create a carrier

POST
/carriers
POST
/api/v1/carriers
$curl -X POST https://tryenvoy.ai/api/v1/carriers \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "Swift Logistics"
>}'
1{
2  "id": "car_3f9a1b2c-4d5e-678f-9012-abcdef123456",
3  "name": "Swift Logistics",
4  "mc_number": "MC123456",
5  "dot_number": "DOT987654",
6  "email": "[email protected]",
7  "phone": "+14155552671",
8  "dispatcher_name": "John Doe",
9  "dispatcher_phone": "+14155552672",
10  "dispatcher_email": "[email protected]",
11  "is_active": true,
12  "provider": "Highway",
13  "ingestion_method": "API",
14  "equipment_types": [
15    "VAN",
16    "REEFER"
17  ],
18  "insurance_expiration": "2025-12-31T23:59:59Z",
19  "w9_on_file": true,
20  "authorized_for_hire": true,
21  "on_time_pickup_pct": 95.5,
22  "on_time_delivery_pct": 97.2,
23  "tracking_compliance_pct": 98,
24  "avg_response_time_min": 15.3,
25  "total_loads_hauled": 1250,
26  "is_onboarded": true,
27  "carrier_rep_user_id": "usr_1a2b3c4d-5e6f-7890-abcd-ef1234567890",
28  "carrier_rep_name": "Alice Smith",
29  "carrier_rep_email": "[email protected]",
30  "is_verified": true,
31  "verified_date": "2024-04-01T10:00:00Z",
32  "created_at": "2023-11-15T08:30:00Z",
33  "updated_at": "2024-04-10T12:00:00Z"
34}

Create a new carrier with Highway verification and fraud checking. Returns existing carrier if MC number matches.

Authentication: Supports API key and bearer token authentication.

Was this page helpful?
Previous

Batch create carriers

Next
Built with

Authentication

AuthorizationBearer

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

Headers

X-Organization-IDstring or nullOptional

Request

This endpoint expects an object.
namestringRequired>=1 character
Carrier company name
tms_carrier_idstring or nullOptional

TMS carrier service ID (e.g., Salesforce CarrierService ID)

mc_numberstring or nullOptional
MC number
emailstring or nullOptional
Primary email
phonestring or nullOptionalformat: "^\+[1-9]\d{1,14}$"8-16 characters

Primary phone (any common format, stored as E.164)

dispatcher_namestring or nullOptional
Dispatcher name
dispatcher_phonestring or nullOptionalformat: "^\+[1-9]\d{1,14}$"8-16 characters

Dispatcher phone (any common format, stored as E.164)

dispatcher_emailstring or nullOptional
Dispatcher email
contactslist of objects or nullOptional
Typed contacts list
on_time_delivery_pctdouble or nullOptional

On-time delivery percentage

on_time_pickup_pctdouble or nullOptional

On-time pickup percentage

total_loads_hauledinteger or nullOptional
Total loads hauled
is_onboardedbooleanOptionalDefaults to false
Whether carrier is onboarded
equipment_typeslist of enums or nullOptional
Equipment types this carrier can haul
carrier_rep_namestring or nullOptional
Carrier rep owner full name
carrier_rep_emailstring or nullOptional
Carrier rep owner email

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
422
Unprocessable Entity Error
429
Too Many Requests Error