Skip to main content
POST
Submit a Vehicle Spotlight lead
Captures an inquiry from a shopper viewing a public Vehicle Spotlight share page (/s/{publicId}) and enqueues CRM (ADF) delivery for the dealership. This route is called by Hrizn share pages on behalf of visitors who are not signed in. Authentication: none. Origin: requests must originate from the Hrizn app; CORS echoes only that origin (never *). Rate limit: 8 per minute and 200 per day per client IP.
Share routes return a flat { "error": "…" } body on failure — not the { "error": { "code", "message" } } envelope used by API-key routes.

Request body

string
required
Vehicle Spotlight article id from the share page.
string
required
Client-generated key (8–128 chars). Replays with the same key return the same lead id with alreadyExisted: true.
string
required
Max 120 chars. Filtered for inappropriate content.
string
required
Max 254 chars.
string
7–40 chars.
string
Max 2000 chars. Filtered for inappropriate content.
string
Share token when present on the page.
string
Optional client correlation id.

Body

application/json
articleId
string<uuid>
required

Vehicle Spotlight article id from the share page

idempotencyKey
string
required

Client-generated key; replays return the same lead id

Required string length: 8 - 128
shopperName
string
required
Maximum string length: 120
shopperEmail
string<email>
required
Maximum string length: 254
shareToken
string | null
Maximum string length: 128
shopperPhone
string | null
Required string length: 7 - 40
shopperMessage
string | null
Maximum string length: 2000
clientRequestId
string | null
Maximum string length: 128

Response

Lead captured (or replayed)

success
boolean
Example:

true

id
string<uuid>
alreadyExisted
boolean

True when the idempotency key matched an existing lead

Last modified on September 7, 2026