BulkUpsertCarriersRequest

  • carriers
    Type: array object[] · CarrierRequest[] …20
    required

    Array of carriers to create or update. Maximum 20 carriers per request.

    • 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.

    • complianceStatus
      Type: object

      Compliance status information.

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

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

    • 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.

    • 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.

    • 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.