Skip to main content

Set a carrier's status

The /v2/carrier/network/set/status endpoint lets you set a carrier's usability status within your network. For TMS integrators, use this to let your users add and remove carriers from their DNU list. DNU carriers do not receive load notifications.

This endpoint must be called from the server side to avoid compromising your secret API key. 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
id_type
string
One of:




id_number
string
A properly formatted MC number, DOT number, SCAC, or CBSA code
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:



Example response

{
    "carrier_status": "approved",
    "status": 200
}