API V3 – Set a Carrier’s Network Status

The /v3/carriers/set/status endpoint lets you set a carrier’s usability status within your network.

For TMS integrators, this endpoint is useful for letting brokers add and remove carriers from their DNU/DNL list. These carriers do not receive load notifications.

Notes on this endpoint:

  1. Requires secret key. This endpoint must be called from the server side to avoid compromising your secret API key. Please do not use your secret key in client-side JavaScript.

HTTP request

Method
URL
POST

Required parameters

Name
Type
Value(s)
pk
string
Your public API key
sk
string
Your secret API key
email
string
Email address of the VETCarriers user who is making the API call
id_type
string
One of:



id_number
string
A properly formatted DOT or MC number
carrier_status
string
One of:


Return values

This endpoint returns an object with the following keys and values.

Key
Type
Value
carrier_status
string
One of:


response
object
{}
An object with the following fields:

{
string
integer
integer
}

Example response

{
    "carrier_status": "dnu",
    "response": {
        "date_time": "2022-11-27 16:43:21 UTC",
        "timestamp": 1669567401,
        "status": 200
    }
}