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 an offer
      • GETList offers
      • GETGet an offer
      • PATCHUpdate an offer
LogoLogo
SupportDashboard
EndpointsOffers

Create an offer

POST
/offers
POST
/api/v1/offers
$curl -X POST https://tryenvoy.ai/api/v1/offers \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "load_id": "load_3fa85f64-5717-4562-b3fc-2c963f66afa6",
>  "offer_amount": 1250.75
>}'
1{
2  "id": "ofr_9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
3  "tms_load_id": "TMS123456789",
4  "load_id": "load_3fa85f64-5717-4562-b3fc-2c963f66afa6",
5  "offer_amount": 1250.75,
6  "status": "pending",
7  "source": "internal",
8  "created_at": "2024-01-15T09:30:00Z",
9  "updated_at": "2024-01-15T09:30:00Z",
10  "carrier_id": "car_7c9e6679-7425-40de-944b-e07fc1f90ae7",
11  "contact_id": "con_1c6b147e-3f4a-4a2a-9f3a-1a2b3c4d5e6f",
12  "call_id": "call_4a1f2b3c-5d6e-7f80-9a1b-2c3d4e5f6a7b",
13  "email_message_id": "msg_1234567890abcdef",
14  "notes": "Offer submitted after review of load details.",
15  "created_by_id": "usr_5f47ac10-3b2a-4d6e-8f9a-1b2c3d4e5f6a",
16  "updated_by_id": "usr_5f47ac10-3b2a-4d6e-8f9a-1b2c3d4e5f6a",
17  "load_number": "LOAD-20240115-001",
18  "carrier": {
19    "id": "car_7c9e6679-7425-40de-944b-e07fc1f90ae7",
20    "name": "Swift Logistics Inc.",
21    "mc_number": "MC123456",
22    "dot_number": "DOT654321",
23    "email": "[email protected]",
24    "phone": "+1-555-123-4567",
25    "dispatcher_name": "Jane Doe",
26    "dispatcher_phone": "+1-555-987-6543",
27    "dispatcher_email": "[email protected]",
28    "is_active": true,
29    "provider": "EnvoyAI",
30    "ingestion_method": "API",
31    "equipment_types": [
32      "VAN",
33      "REEFER"
34    ],
35    "insurance_expiration": "2024-12-31T23:59:59Z",
36    "w9_on_file": true,
37    "authorized_for_hire": true,
38    "on_time_pickup_pct": 95.5,
39    "on_time_delivery_pct": 97.2,
40    "tracking_compliance_pct": 98,
41    "avg_response_time_min": 15.3,
42    "total_loads_hauled": 1200,
43    "is_onboarded": true,
44    "carrier_rep_user_id": "usr_8a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
45    "carrier_rep_name": "Michael Smith",
46    "carrier_rep_email": "[email protected]",
47    "is_verified": true,
48    "verified_date": "2023-11-01T10:00:00Z",
49    "created_at": "2020-05-20T08:00:00Z",
50    "updated_at": "2024-01-10T12:00:00Z"
51  },
52  "contact_name": "Emily Johnson",
53  "contact_phone": "+1-555-234-5678",
54  "email_conversation_id": "conv_abcdef1234567890",
55  "rep_name": "Robert Lee"
56}

Create a new offer for a load.

Authentication: Supports API key and bearer token authentication.

Was this page helpful?
Previous

List offers

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.
load_idstringRequiredformat: "uuid"

Load ID (prefixed or raw UUID)

offer_amountdoubleRequired

Amount offered (positive)

tms_load_idstring or nullOptional
External load identifier from TMS
carrier_idstring or nullOptional
Carrier making the offer
statusstringOptionalDefaults to pending
Status of the offer
notesstring or nullOptional
Notes or comments about the offer
sourcestringOptionalDefaults to internal
Source of the offer

Response

Successful Response
idstringformat: "^ofr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
tms_load_idstring
load_idstringformat: "^load_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
offer_amountdouble
statusenum
Allowed values:
sourcestring
created_atdatetime
updated_atdatetime
carrier_idstringformat: "^car_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
contact_idstringformat: "^con_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
call_idstringformat: "^call_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
email_message_idstring or null
notesstring or null
created_by_idstringformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
updated_by_idstringformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
load_numberstring or null
carrierobject or null

v1 carrier response - wraps domain CarrierModel with prefixed IDs.

contact_namestring or null
contact_phonestring or null
email_conversation_idstring or null
rep_namestring or null

Errors

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