CarrierContactRequest

  • 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 — manages invoices and payments
    • 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.