PartnerLeadRequest

Request model for submitting a customer lead for vehicle protection plan quotes. Used for lead generation campaigns where follow-up happens later via email or phone.

  • lead
    Type: object · LeadContactInfo
    required

    Customer contact information for the lead. All fields are required for lead processing.

    • email
      Type: stringFormat: email
      required

      Customer's email address. Required. Used for sending plan quotes and follow-up communications.

    • firstName
      Type: string
      min length:  
      1
      max length:  
      50
      required

      Customer's first name. Required. Maximum 50 characters.

    • lastName
      Type: string
      min length:  
      1
      max length:  
      50
      required

      Customer's last name. Required. Maximum 50 characters.

  • vehicle
    Type: object · VehicleSearchInfo
    required

    Vehicle information for plan search. You must provide ONE of the following combinations:

    1. VIN (17 characters) - Most accurate method
    2. Make + Model + Year - All three required together
    3. LicensePlate + State - State is always required with license plate
    • state
      Type: string
      min length:  
      2
      max length:  
      2
      required

      Two-letter US state code (e.g., "NY", "CA", "TX"). Required. Used for location-based pricing and license plate lookups.

    • licensePlate
      Type: string | null
      min length:  
      1
      max length:  
      8

      Vehicle license plate number (1-8 characters). Alternative to VIN or Make/Model/Year. State must also be provided for license plate lookup.

    • make
      Type: string | null

      Vehicle manufacturer (e.g., "Toyota", "Ford", "Honda"). Required if VIN and LicensePlate are not provided. Must be provided together with Model and Year.

    • mileage
      Type: integerFormat: int32

      Current vehicle odometer reading in miles. Required. Must be between 1 and 250,000 miles.

    • model
      Type: string | null

      Vehicle model name (e.g., "Camry", "F-150", "Civic"). Required if VIN and LicensePlate are not provided. Must be provided together with Make and Year.

    • vin
      Type: string | null
      min length:  
      17
      max length:  
      17

      17-character Vehicle Identification Number. Required if Make/Model/Year and LicensePlate are not provided. VIN is the most accurate vehicle identification method.

    • year
      Type: integer | nullFormat: int32
      min:  
      1990
      max:  
      2030

      Vehicle model year (e.g., 2020). Required if VIN and LicensePlate are not provided. Must be provided together with Make and Model. Must be between 1990 and 2030.

  • partner
    Type: string | null

    Your unique partner identifier provided during onboarding. Optional — if omitted, resolved automatically from your authentication token.

  • transactionId
    Type: string | null

    Optional. Your internal reference or transaction ID for tracking this lead. This ID will be included in webhook notifications for correlation.

  • utmParameters
    Type: string | null

    Optional. UTM parameters for marketing attribution and tracking. Format: "utm_source=partner&utm_medium=cps&utm_campaign=lead-gen"