CarrierRequest
- nameType: stringrequired
Carrier name (required)
- tmsType: string
Id requiredTMS identifier for the carrier. Used for matching existing carriers. Cannot be changed after creation.
- addressType: object
Carrier address.
- cityType: string
City name
- companyType: string
Company name
- countryType: string
Must be 2-letter ISO country code as listed here: https://www.iban.com/country-codes
- nameType: string
Location name (e.g., building name)
- postalType: string
Code Postal or ZIP code
- stateType: string
Or Province State or province code
- street1Type: string
Street address line 1
- street2Type: string
Street address line 2 (optional)
- complianceType: object
Status Compliance status information.
- codesType: object
Compliance codes as key-value pairs
- contactsType: array object[] · CarrierContactRequest[]
Array of carrier contacts (carrier employees). Pass an empty array [] to clear all contacts when updating.
- emailType: stringFormat: email
Contact email address. Either email or phone is required.
- nameType: string
Contact name
- phoneType: string
Phone number in E.164 format (e.g., +13125551234). Either email or phone is required.
- phoneType: string
Extension Phone extension
- preferredType: stringenum
Contact Mode Preferred method of contact
values- E
M A I L - P
H O N E _ C A L L - T
E X T _ M E S S A G E - T
E L E G R A M
- rolesType: array string[]enum
Carrier contact roles:
ACCOUNTANT— AccountantAP_REP— manages invoices and paymentsDISPATCHER— DispatcherDRIVER— DriverOTHER— Other
values- A
C C O U N T A N T - A
P _ R E P - D
I S P A T C H E R - D
R I V E R - O
T H E R
- tmsType: string
Id TMS identifier for matching existing contacts. If provided, the system will match and update the existing contact.
- customType: object
Data 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.- propertyType: anything
Name
- dotType: integer
Number DOT number
- emailType: stringFormat: email
Carrier email address.
- managersType: array object[] · BrokerageContactRequest[]
Array of organization contacts (managers) who manage this carrier. Pass an empty array [] to clear all managers when updating.
- emailType: stringFormat: email
Contact email address
- nameType: string
Contact name
- phoneType: string
Phone number in E.164 format (e.g., +13125551234)
- phoneType: string
Extension Phone extension
- preferredType: stringenum
Contact Mode Preferred method of contact
values- E
M A I L - P
H O N E _ C A L L - T
E X T _ M E S S A G E - T
E L E G R A M
- rolesType: 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,AP_REP— Accounts Payable Specialist, who manages invoice and payment processes,AFTER_HOURS_REP— contact available outside of regular business hours.values- C
A R R I E R _ R E P - A
C C O U N T _ M A N A G E R - O
P E R A T I O N S _ R E P - B
O O K E D _ B Y - C
U S T O M E R _ R E P - C
U S T O M E R _ T E A M - A
P _ R E P - A
F T E R _ H O U R S _ R E P
- tmsType: string
Id TMS identifier for matching existing contacts. If provided, the system will match and update the existing contact.
- mcType: integer
Number MC number
- notesType: string
Free-form notes about the carrier.
- phoneType: string
Phone number in E.164 format (e.g., +13125551234).
- phoneType: string
Extension Phone extension.
- scacType: string
SCAC code
- statusType: object
Carrier status.
- codeType: stringenum
Status code indicating the carrier's current state
values- A
C T I V E - D
O _ N O T _ U S E
- reasonType: string
Optional reason for the status