API V4 – Set a Carrier’s Network Status

The /v4/carriers/set/carrier/network/status endpoint lets you change a carrier’s operational status within your network.

When a carrier is on active status, they will receive your load announcements. A carrier in pending or DNU status will not receive your load announcements.

Notes on this endpoint:

  1. Authentication via header. To authenticate your API call, pass in your public API key with the X-Api-Key HTTP header.

HTTP Request

Method URL
POST https://api.brokercarrier.com/v4/carriers/set/carrier/network/status

Required Parameters

Name Type Value(s)
id_type string One of: dot, mc
id_number string The carrier's DOT number or MC number
doc string One of: active, pending, dnu

Example Response

This endpoint will return a either an error message or a short success message that displays the carrier's new network status.

        "status": "pending"