Insert leads in mykaarma.

Insert leads in mykaarma.

Path Parameters

dealerUuid string required

Header Parameters

authorization string required

application/json

Request Body required

customer object
uuid string
vehicle object
uuid string
trackingId string
topic string
description 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
]
campaign object
name string
code string
status string

Possible values: [NEW]

lastContactDate string
leadId string
webId string
leadType string

Possible values: [RECALL, SERVICE_DEMAND]

Responses

• 200
• 204
• 400
• 401
• 403
• 404
• 500

---

OK

application/json

Schema

Example (from schema)

---

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
]
isNewCreated boolean
prospectUuid string

{
  "statusCode": 0,
  "error": {
    "code": "string",
    "description": "string",
    "metadata": {}
  },
  "warnings": [
    {
      "code": "string",
      "description": "string",
      "metadata": {}
    }
  ],
  "isNewCreated": true,
  "prospectUuid": "string"
}

No Content

*/*

Schema

Example (from schema)

---

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
]

{
  "statusCode": 0,
  "error": {
    "code": "string",
    "description": "string",
    "metadata": {}
  },
  "warnings": [
    {
      "code": "string",
      "description": "string",
      "metadata": {}
    }
  ]
}

Bad Request

*/*

Schema

Example (from schema)

---

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
]

{
  "statusCode": 0,
  "error": {
    "code": "string",
    "description": "string",
    "metadata": {}
  },
  "warnings": [
    {
      "code": "string",
      "description": "string",
      "metadata": {}
    }
  ]
}

Unauthorized

*/*

Schema

Example (from schema)

---

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
]

{
  "statusCode": 0,
  "error": {
    "code": "string",
    "description": "string",
    "metadata": {}
  },
  "warnings": [
    {
      "code": "string",
      "description": "string",
      "metadata": {}
    }
  ]
}

Forbidden

*/*

Schema

Example (from schema)

---

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
]

{
  "statusCode": 0,
  "error": {
    "code": "string",
    "description": "string",
    "metadata": {}
  },
  "warnings": [
    {
      "code": "string",
      "description": "string",
      "metadata": {}
    }
  ]
}

Not Found

*/*

Schema

Example (from schema)

---

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
]

{
  "statusCode": 0,
  "error": {
    "code": "string",
    "description": "string",
    "metadata": {}
  },
  "warnings": [
    {
      "code": "string",
      "description": "string",
      "metadata": {}
    }
  ]
}

Internal Server Error

*/*

Schema

Example (from schema)

---

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
]

{
  "statusCode": 0,
  "error": {
    "code": "string",
    "description": "string",
    "metadata": {}
  },
  "warnings": [
    {
      "code": "string",
      "description": "string",
      "metadata": {}
    }
  ]
}

POST /v2/dealer/:dealerUuid

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/leads

Username

Password

dealerUuid — path required

authorization — header required

Body required

{
  "customer": {
    "uuid": "string"
  },
  "vehicle": {
    "uuid": "string",
    "trackingId": "string",
    "topic": "string",
    "description": "string"
  },
  "dealerDetails": {
    "name": "string",
    "code": "string",
    "source": "MMC"
  },
  "services": [
    {
      "name": "string",
      "code": "string",
      "type": "string",
      "dueDate": "string"
    }
  ],
  "campaign": {
    "name": "string",
    "code": "string"
  },
  "status": "NEW",
  "lastContactDate": "string",
  "leadId": "string",
  "webId": "string",
  "leadType": "RECALL"
}

Accept

application/json*/*

curl / cURL

curl -L -X POST '/leads/v2/dealer/:dealerUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customer": {
    "uuid": "string"
  },
  "vehicle": {
    "uuid": "string",
    "trackingId": "string",
    "topic": "string",
    "description": "string"
  },
  "dealerDetails": {
    "name": "string",
    "code": "string",
    "source": "MMC"
  },
  "services": [
    {
      "name": "string",
      "code": "string",
      "type": "string",
      "dueDate": "string"
    }
  ],
  "campaign": {
    "name": "string",
    "code": "string"
  },
  "status": "NEW",
  "lastContactDate": "string",
  "leadId": "string",
  "webId": "string",
  "leadType": "RECALL"
}'

python / requests

curl -L -X POST '/leads/v2/dealer/:dealerUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customer": {
    "uuid": "string"
  },
  "vehicle": {
    "uuid": "string",
    "trackingId": "string",
    "topic": "string",
    "description": "string"
  },
  "dealerDetails": {
    "name": "string",
    "code": "string",
    "source": "MMC"
  },
  "services": [
    {
      "name": "string",
      "code": "string",
      "type": "string",
      "dueDate": "string"
    }
  ],
  "campaign": {
    "name": "string",
    "code": "string"
  },
  "status": "NEW",
  "lastContactDate": "string",
  "leadId": "string",
  "webId": "string",
  "leadType": "RECALL"
}'

go / native

curl -L -X POST '/leads/v2/dealer/:dealerUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customer": {
    "uuid": "string"
  },
  "vehicle": {
    "uuid": "string",
    "trackingId": "string",
    "topic": "string",
    "description": "string"
  },
  "dealerDetails": {
    "name": "string",
    "code": "string",
    "source": "MMC"
  },
  "services": [
    {
      "name": "string",
      "code": "string",
      "type": "string",
      "dueDate": "string"
    }
  ],
  "campaign": {
    "name": "string",
    "code": "string"
  },
  "status": "NEW",
  "lastContactDate": "string",
  "leadId": "string",
  "webId": "string",
  "leadType": "RECALL"
}'

nodejs / axios

curl -L -X POST '/leads/v2/dealer/:dealerUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customer": {
    "uuid": "string"
  },
  "vehicle": {
    "uuid": "string",
    "trackingId": "string",
    "topic": "string",
    "description": "string"
  },
  "dealerDetails": {
    "name": "string",
    "code": "string",
    "source": "MMC"
  },
  "services": [
    {
      "name": "string",
      "code": "string",
      "type": "string",
      "dueDate": "string"
    }
  ],
  "campaign": {
    "name": "string",
    "code": "string"
  },
  "status": "NEW",
  "lastContactDate": "string",
  "leadId": "string",
  "webId": "string",
  "leadType": "RECALL"
}'

ruby / Net::HTTP

curl -L -X POST '/leads/v2/dealer/:dealerUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customer": {
    "uuid": "string"
  },
  "vehicle": {
    "uuid": "string",
    "trackingId": "string",
    "topic": "string",
    "description": "string"
  },
  "dealerDetails": {
    "name": "string",
    "code": "string",
    "source": "MMC"
  },
  "services": [
    {
      "name": "string",
      "code": "string",
      "type": "string",
      "dueDate": "string"
    }
  ],
  "campaign": {
    "name": "string",
    "code": "string"
  },
  "status": "NEW",
  "lastContactDate": "string",
  "leadId": "string",
  "webId": "string",
  "leadType": "RECALL"
}'

csharp / RestSharp

curl -L -X POST '/leads/v2/dealer/:dealerUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customer": {
    "uuid": "string"
  },
  "vehicle": {
    "uuid": "string",
    "trackingId": "string",
    "topic": "string",
    "description": "string"
  },
  "dealerDetails": {
    "name": "string",
    "code": "string",
    "source": "MMC"
  },
  "services": [
    {
      "name": "string",
      "code": "string",
      "type": "string",
      "dueDate": "string"
    }
  ],
  "campaign": {
    "name": "string",
    "code": "string"
  },
  "status": "NEW",
  "lastContactDate": "string",
  "leadId": "string",
  "webId": "string",
  "leadType": "RECALL"
}'

php / cURL

curl -L -X POST '/leads/v2/dealer/:dealerUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customer": {
    "uuid": "string"
  },
  "vehicle": {
    "uuid": "string",
    "trackingId": "string",
    "topic": "string",
    "description": "string"
  },
  "dealerDetails": {
    "name": "string",
    "code": "string",
    "source": "MMC"
  },
  "services": [
    {
      "name": "string",
      "code": "string",
      "type": "string",
      "dueDate": "string"
    }
  ],
  "campaign": {
    "name": "string",
    "code": "string"
  },
  "status": "NEW",
  "lastContactDate": "string",
  "leadId": "string",
  "webId": "string",
  "leadType": "RECALL"
}'

java / OkHttp

curl -L -X POST '/leads/v2/dealer/:dealerUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customer": {
    "uuid": "string"
  },
  "vehicle": {
    "uuid": "string",
    "trackingId": "string",
    "topic": "string",
    "description": "string"
  },
  "dealerDetails": {
    "name": "string",
    "code": "string",
    "source": "MMC"
  },
  "services": [
    {
      "name": "string",
      "code": "string",
      "type": "string",
      "dueDate": "string"
    }
  ],
  "campaign": {
    "name": "string",
    "code": "string"
  },
  "status": "NEW",
  "lastContactDate": "string",
  "leadId": "string",
  "webId": "string",
  "leadType": "RECALL"
}'

powershell / RestMethod

curl -L -X POST '/leads/v2/dealer/:dealerUuid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "customer": {
    "uuid": "string"
  },
  "vehicle": {
    "uuid": "string",
    "trackingId": "string",
    "topic": "string",
    "description": "string"
  },
  "dealerDetails": {
    "name": "string",
    "code": "string",
    "source": "MMC"
  },
  "services": [
    {
      "name": "string",
      "code": "string",
      "type": "string",
      "dueDate": "string"
    }
  ],
  "campaign": {
    "name": "string",
    "code": "string"
  },
  "status": "NEW",
  "lastContactDate": "string",
  "leadId": "string",
  "webId": "string",
  "leadType": "RECALL"
}'