POST
/
api
/
v1
/
carriers
{
  "event_type": "carrier_upsert",
  "org_id": "01111111-11aa-11aa-1111-a11111111111",
  "mc_number": "55555",
  "dot_number": "123456",
  "status": "active",
  "contacts": [
    {
      "name": "John Dispatcher",
      "email": "dispatch@abctrucking.com",
      "phone": "5551234567",
      "type": "dispatch",
      "extension": "101",
      "preferred_contact_method": "phone"
    },
    {
      "name": "Jane Driver",
      "email": "jane@abctrucking.com",
      "phone": "5559876543",
      "type": "driver",
      "preferred_contact_method": "text"
    }
  ],
  "markets": [
    {
      "origin": {
        "city": "Chicago",
        "state": "IL",
        "zip": "60601",
        "country": "US"
      },
      "destination": {
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "US"
      }
    },
    {
      "origin": {
        "city": "Dallas",
        "state": "TX",
        "zip": "75201",
        "country": "US"
      },
      "destination": {
        "city": "Los Angeles",
        "state": "CA",
        "zip": "90210",
        "country": "US"
      }
    }
  ]
}
{
  "id": "01111111-11aa-11aa-1111-a11111111111",  
  "created_at": "2024-03-19T08:00:00Z",
  "status": "active",
  "mc_number": "55555",
  "dot_number": "123456",
  "contacts": [
    {
      "name": "John Dispatcher",
      "email": "dispatch@abctrucking.com", 
      "phone": "5551234567",
      "type": "dispatch"
    }
  ],
  "markets": [
    {
      "origin": {
        "city": "Chicago",
        "state": "IL", 
        "zip": "60601"
      },
      "destination": {
        "city": "New York",
        "state": "NY",
        "zip": "10001" 
      }
    }
  ]
}
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. Must be ‘carrier_upsert’.
org_id
string
required
Your organization’s unique identifier
mc_number
string
The carrier’s MC (Motor Carrier) number
dot_number
string
The carrier’s DOT (Department of Transportation) number
status
enum
Carrier’s status. Must be one of: - active - fail - inactive - in_review - not_set
contacts
array
List of contacts for this carrier
markets
array
List of markets this carrier services

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",
  "dot_number": "123456",
  "status": "active",
  "contacts": [
    {
      "name": "John Dispatcher",
      "email": "dispatch@abctrucking.com",
      "phone": "5551234567",
      "type": "dispatch",
      "extension": "101",
      "preferred_contact_method": "phone"
    },
    {
      "name": "Jane Driver",
      "email": "jane@abctrucking.com",
      "phone": "5559876543",
      "type": "driver",
      "preferred_contact_method": "text"
    }
  ],
  "markets": [
    {
      "origin": {
        "city": "Chicago",
        "state": "IL",
        "zip": "60601",
        "country": "US"
      },
      "destination": {
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "US"
      }
    },
    {
      "origin": {
        "city": "Dallas",
        "state": "TX",
        "zip": "75201",
        "country": "US"
      },
      "destination": {
        "city": "Los Angeles",
        "state": "CA",
        "zip": "90210",
        "country": "US"
      }
    }
  ]
}
{
  "id": "01111111-11aa-11aa-1111-a11111111111",  
  "created_at": "2024-03-19T08:00:00Z",
  "status": "active",
  "mc_number": "55555",
  "dot_number": "123456",
  "contacts": [
    {
      "name": "John Dispatcher",
      "email": "dispatch@abctrucking.com", 
      "phone": "5551234567",
      "type": "dispatch"
    }
  ],
  "markets": [
    {
      "origin": {
        "city": "Chicago",
        "state": "IL", 
        "zip": "60601"
      },
      "destination": {
        "city": "New York",
        "state": "NY",
        "zip": "10001" 
      }
    }
  ]
}