POST
/
api
/
v1
/
carriers
{
  "event_type": "carrier_upsert",
  "org_id": "01111111-11aa-11aa-1111-a11111111111",
  "mc_number": "55555",
  "name": "ABC Trucking LLC",
  "status": "ACTIVE"
}
{
  "id": "01111111-11aa-11aa-1111-a11111111111",
  "created_at": "2024-03-19T08:00:00Z",
  "status": "ACTIVE",
  "mc_number": "55555",
  "name": "ABC Trucking LLC"
}
Create or update a carrier with their MC number and status information. This can only be used if you coordinate with us, we will need to give you an API key and the endpoint to use.

Authentication

This endpoint requires an API key in the X-API-Key header:
X-API-Key: <your_api_key>

Body

event_type
string
required
Type of event. For now, only ‘carrier_upsert’ is supported.
org_id
string
required
Your organization’s unique identifier
mc_number
string
required
The carrier’s MC (Motor Carrier) number
name
string
required
The legal business name of the carrier
status
enum
required
Carrier’s status. Must be one of: - ACTIVE - INACTIVE - PENDING - BLOCKED

Response

id
string
The UUID of the created/updated carrier
created_at
string
ISO 8601 formatted creation timestamp
{
  "event_type": "carrier_upsert",
  "org_id": "01111111-11aa-11aa-1111-a11111111111",
  "mc_number": "55555",
  "name": "ABC Trucking LLC",
  "status": "ACTIVE"
}
{
  "id": "01111111-11aa-11aa-1111-a11111111111",
  "created_at": "2024-03-19T08:00:00Z",
  "status": "ACTIVE",
  "mc_number": "55555",
  "name": "ABC Trucking LLC"
}