Skip to main content
POST
Upsert carrier relationships

Authorizations

api-key
string
header
required

Body

application/json
carrierRelationships
object[]
required

Response

Ok

carrierRelationships
(object | null)[]
required

A carrier relationship represents the relationship between a carrier and an organization, including their onboarding status and whether they can be assigned to freight.

If a carrier relationship is not found, the carrier will be offered an onboarding link but will not be assigned to freight until a relationship is created.

A NEEDS_REVIEW but onboarded carrier still requires manual review prior to being assigned to freight. An ACTIVE but not onboarded carrier can be assigned to freight but the carrier is still offered an onboarding link.

DO_NOT_DISPATCH should be used to block a carrier from being assigned to freight at an organization level. Use freight level rules to block a carrier from being assigned to specific freight.