Sign in

v1

latestOpenAPI 3.1.02026-07-246246106.8 KB
Carrier Hub

Bulk add, update, or remove carriers in a broker's network

Performs batched add, update, and remove operations against the authenticated broker's network. Carriers are identified by DOT number only.

The request is an array of operation groups; each group specifies an action and the DOT numbers it applies to. The response mirrors that structure and, for each operation group, reports the DOT numbers that were affected as well as the DOT numbers that were skipped along with a per-item reason and code.

Each operation result reports DOT numbers in three buckets: affected (the action was performed exactly as requested), adjusted (the action was performed but altered from what was requested - for example, an Add that would exceed the broker's active-network limit is added to the inactive list instead), and skipped (the action was not performed; reason explains why).

Semantics:

  • Add - affected are DOT numbers that were not already in the network and have been added to the active list when activate is true or to the inactive list when activate is false. Adjusted are DOT numbers that were added but placed differently than requested - currently, this occurs when adding with activate true would exceed the broker's active-network limit, in which case the overflow DOTs are added to the inactive list and reported here with reason OverLimitAddedInactive. Skipped are DOT numbers already in the network (AddDuplicate), invalid (InvalidDot), or otherwise not added (Other). activate is required.
  • Update - affected are DOT numbers that were in the network and now appear on the active list when activate is true or on the inactive list when activate is false. A carrier already on the target list is still considered affected. Skipped are DOT numbers not in the network (UpdateNotFound), invalid (InvalidDot), or otherwise not updated (Other). activate is required.
  • Remove - affected are DOT numbers that were in the network and have been removed from it entirely (no longer on either list). Skipped are DOT numbers not in the network (RemoveNotFound), invalid (InvalidDot), or otherwise not removed (Other). activate must be omitted or null; supplying a value results in a 400 response.
post/mynetwork

Query parameters

relationship_type'Favorite' | 'Blocked' | 'Watched'

The type of relationship

The relationship type the operations apply to. Must be a relationship type that is tracked at the account level. Defaults to Watched.

relationship_type_group'MyCarriers' | 'CarrierHubNetwork'

The group of relationship types

The group of relationship types the operations apply to. Must be a group that is tracked at the account level. Defaults to CarrierHubNetwork.

Request body

action'Add' | 'Remove' | 'Update' required

The action to perform on the supplied DOT numbers

dotNumbersstring[] required

The DOT numbers the action applies to.

activateboolean nullable

The desired active state of the affected carriers. Required and non-null for Add and Update; must be omitted or null for Remove. See the schema description for full conditional rules.

Example request

[
  {
    "action": "Add",
    "dotNumbers": [
      "1234567"
    ],
    "activate": true
  }
]

Response

The bulk operations were processed. The response contains one result per operation group in the request, reporting affected and skipped DOT numbers.

action'Add' | 'Remove' | 'Update' required

The action to perform on the supplied DOT numbers

affectedstring[] required

DOT numbers whose action was performed exactly as requested. For Add these are DOT numbers that were newly added to the requested list; for Update, those that were updated to the requested state; for Remove, those that were removed.

Example response

[
  {
    "action": "Add",
    "affected": [
      "1234567"
    ],
    "adjusted": [
      {
        "dot": "1234567",
        "reason": "OverLimitAddedInactive",
        "code": "ADDED_TO_INACTIVE_OVER_LIMIT"
      }
    ],
    "skipped": [
      {
        "dot": "1234567",
        "reason": "AddDuplicate",
        "code": "ADD_DUPLICATE"
      }
    ]
  }
]