CarrierRequest

  • name
    Type: string
    required

    Carrier name (required)

  • tmsId
    Type: string
    required

    TMS identifier for the carrier. Used for matching existing carriers. Cannot be changed after creation.

  • address
    Type: object

    Carrier address.

    • city
      Type: string

      City name

    • company
      Type: string

      Company name

    • country
      Type: string

      Must be 2-letter ISO country code as listed here: https://www.iban.com/country-codes

    • name
      Type: string

      Location name (e.g., building name)

    • postalCode
      Type: string

      Postal or ZIP code

    • stateOrProvince
      Type: string

      State or province code

    • street1
      Type: string

      Street address line 1

    • street2
      Type: string

      Street address line 2 (optional)

  • complianceStatus
    Type: object

    Compliance status information.

    • codes
      Type: object

      Compliance codes as key-value pairs

  • contacts
    Type: array object[] · CarrierContactRequest[]

    Array of carrier contacts (carrier employees). Pass an empty array [] to clear all contacts when updating.

    • email
      Type: stringFormat: email

      Contact email address. Either email or phone is required.

    • name
      Type: string

      Contact name

    • phone
      Type: string

      Phone number in E.164 format (e.g., +13125551234). Either email or phone is required.

    • phoneExtension
      Type: string

      Phone extension

    • preferredContactMode
      Type: stringenum

      Preferred method of contact

      values
      • EMAIL
      • PHONE_CALL
      • TEXT_MESSAGE
      • TELEGRAM
    • roles
      Type: array string[]enum

      Carrier contact roles:

      • ACCOUNTANT — Accountant
      • AP_REP — Accounts Payable Specialist
      • DISPATCHER — Dispatcher
      • DRIVER — Driver
      • OTHER — Other
      values
      • ACCOUNTANT
      • AP_REP
      • DISPATCHER
      • DRIVER
      • OTHER
    • tmsId
      Type: string

      TMS identifier for matching existing contacts. If provided, the system will match and update the existing contact.

  • customData
    Type: object · CarrierCustomData

    Optional metadata for the carrier. Use string keys; each value may be a string, number, boolean, array of JSON-safe values, or nested object with the same rules. Omit or send {} when you have nothing to store.

    • propertyName
      Type: anything
  • dotNumber
    Type: integer

    DOT number

  • email
    Type: stringFormat: email

    Carrier email address.

  • managers
    Type: array object[] · BrokerageContactRequest[]

    Array of organization contacts (managers) who manage this carrier. Pass an empty array [] to clear all managers when updating.

    • email
      Type: stringFormat: email

      Contact email address

    • name
      Type: string

      Contact name

    • phone
      Type: string

      Phone number in E.164 format (e.g., +13125551234)

    • phoneExtension
      Type: string

      Phone extension

    • preferredContactMode
      Type: stringenum

      Preferred method of contact

      values
      • EMAIL
      • PHONE_CALL
      • TEXT_MESSAGE
      • TELEGRAM
    • roles
      Type: array string[]enum

      The employee's role(s) on each load. Possible values: CARRIER_REP — rep who gets commission credit for the load, OPERATIONS_REP — manages day-to-day operations on the load, ACCOUNT_MANAGER — manages the customer relationship, CUSTOMER_REP — sales rep to the customer, CUSTOMER_TEAM — part of the broader customer team, BOOKED_BY — party who booked the load.

      values
      • CARRIER_REP
      • ACCOUNT_MANAGER
      • OPERATIONS_REP
      • BOOKED_BY
      • CUSTOMER_REP
      • CUSTOMER_TEAM
    • tmsId
      Type: string

      TMS identifier for matching existing contacts. If provided, the system will match and update the existing contact.

  • mcNumber
    Type: integer

    MC number

  • notes
    Type: string

    Free-form notes about the carrier.

  • phone
    Type: string

    Phone number in E.164 format (e.g., +13125551234).

  • phoneExtension
    Type: string

    Phone extension.

  • scac
    Type: string

    SCAC code

  • status
    Type: object

    Carrier status.

    • code
      Type: stringenum

      Status code indicating the carrier's current state

      values
      • ACTIVE
      • DO_NOT_USE
    • reason
      Type: string

      Optional reason for the status