Skip to main content

Insert leads in mykaarma.​

Insert leads in mykaarma.

Path Parameters
    dealerUuid string required
Header Parameters
    authorization string required
Request Body required
    customer object
    uuid string
    customerKey string
    firstName string
    middleName string
    lastName string
    company string
    isBusiness boolean
    addresses object[]
  • Array [
    • line1 string
    line2 string
    city string
    zip string
    addressType string
    type string

    Possible values: [COMMON, PRIMARY, BILLING, OTHER]

    country string
    updateTS date-time
    uuid string
    isValid boolean
    isPreferred boolean
    state string
  • ]
    • preferredLocale string
    emails object[]
  • Array [
    • emailAddress string
    label string
    okToEmail boolean
    isPreferred boolean
    comments string
  • ]
    • phoneNumbers object[]
  • Array [
    • phoneNumber string
    label string
    okToCall boolean
    okToText boolean
    isPreferred boolean
    comments string
  • ]
    • vehicle object
    trackingId string
    topic string
    description string
    vin string
    vehicleKey string
    isValid boolean
    imageUrl string
    brandId int64
    licensePlate string
    color string
    vehicleModel string
    vehicleYear string
    vehicleTrim string
    uuid string
    vehicleEngine string
    estimatedMileage string
    vehicleMake string
    dealerDetails object
    name string
    code string
    source string

    Possible values: [MMC, BMW_SPARC, AUTOPOINT]

    services object[]
  • Array [
    • name string
    code string
    type string
    dueDate string
  • ]
    • status string

    Possible values: [NEW]

    lastContactDate string
    leadId string
    webId string
    leadType string

    Possible values: [RECALL, SERVICE_DEMAND]

Responses

OK

Schema
    statusCode int32
    error object
    code string
    description string
    metadata object
    property name* object
    warnings object[]
  • Array [
    • code string
    description string
    metadata object
    property name* string
  • ]
    • requestId string
    message string
    status string
POST /v3/dealers/:dealerUuid/leads

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL
/leads
Username
Password
dealerUuid — path required
authorization — header required
Body required
{

  "customer": {

    "uuid": "string",

    "customerKey": "string",

    "firstName": "string",

    "middleName": "string",

    "lastName": "string",

    "company": "string",

    "isBusiness": true,

    "addresses": [

      {

        "line1": "string",

        "line2": "string",

        "city": "string",

        "zip": "string",

        "addressType": "string",

        "type": "COMMON",

        "country": "string",

        "updateTS": "2025-04-07T07:51:23.604Z",

        "uuid": "string",

        "isValid": true,

        "isPreferred": true,

        "state": "string"

      }

    ],

    "preferredLocale": "string",

    "emails": [

      {

        "emailAddress": "string",

        "label": "string",

        "okToEmail": true,

        "isPreferred": true,

        "comments": "string"

      }

    ],

    "phoneNumbers": [

      {

        "phoneNumber": "string",

        "label": "string",

        "okToCall": true,

        "okToText": true,

        "isPreferred": true,

        "comments": "string"

      }

    ]

  },

  "vehicle": {

    "trackingId": "string",

    "topic": "string",

    "description": "string",

    "vin": "string",

    "vehicleKey": "string",

    "isValid": true,

    "imageUrl": "string",

    "brandId": 0,

    "licensePlate": "string",

    "color": "string",

    "vehicleModel": "string",

    "vehicleYear": "string",

    "vehicleTrim": "string",

    "uuid": "string",

    "vehicleEngine": "string",

    "estimatedMileage": "string",

    "vehicleMake": "string"

  },

  "dealerDetails": {

    "name": "string",

    "code": "string",

    "source": "MMC"

  },

  "services": [

    {

      "name": "string",

      "code": "string",

      "type": "string",

      "dueDate": "string"

    }

  ],

  "status": "NEW",

  "lastContactDate": "string",

  "leadId": "string",

  "webId": "string",

  "leadType": "RECALL"

}
Accept
curl / cURL
curl -L -X POST '/leads/v3/dealers/:dealerUuid/leads' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customer": {
    "uuid": "string",
    "customerKey": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "company": "string",
    "isBusiness": true,
    "addresses": [
      {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "zip": "string",
        "addressType": "string",
        "type": "COMMON",
        "country": "string",
        "updateTS": "2025-04-07T07:51:23.604Z",
        "uuid": "string",
        "isValid": true,
        "isPreferred": true,
        "state": "string"
      }
    ],
    "preferredLocale": "string",
    "emails": [
      {
        "emailAddress": "string",
        "label": "string",
        "okToEmail": true,
        "isPreferred": true,
        "comments": "string"
      }
    ],
    "phoneNumbers": [
      {
        "phoneNumber": "string",
        "label": "string",
        "okToCall": true,
        "okToText": true,
        "isPreferred": true,
        "comments": "string"
      }
    ]
  },
  "vehicle": {
    "trackingId": "string",
    "topic": "string",
    "description": "string",
    "vin": "string",
    "vehicleKey": "string",
    "isValid": true,
    "imageUrl": "string",
    "brandId": 0,
    "licensePlate": "string",
    "color": "string",
    "vehicleModel": "string",
    "vehicleYear": "string",
    "vehicleTrim": "string",
    "uuid": "string",
    "vehicleEngine": "string",
    "estimatedMileage": "string",
    "vehicleMake": "string"
  },
  "dealerDetails": {
    "name": "string",
    "code": "string",
    "source": "MMC"
  },
  "services": [
    {
      "name": "string",
      "code": "string",
      "type": "string",
      "dueDate": "string"
    }
  ],
  "status": "NEW",
  "lastContactDate": "string",
  "leadId": "string",
  "webId": "string",
  "leadType": "RECALL"
}'