Skip to main content
POST
Record an outbound shop click

Body

application/json
offerId
string
required

The offer this click is for

sessionId
string
required

Anonymous client-generated UUID grouping clicks within one shopper session

Example:

"a1b2c3d4-shopper-session"

zip
string
Example:

"78701"

city
string
Example:

"Austin"

state
string
Example:

"TX"

referrer
string
Example:

"https://www.google.com/"

utm
object
Example:
contact
Shop Click Contact · object

Optional contact capture before a lead_gen redirect — always skippable. When present, creates a provider lead (Customer + TeamCustomer).

serviceAddress
Shop Click Service Address · object

Full service address, when the handoff was reached through the checkout wizard. Its city/state/zipCode fill in for any top-level zip/city/state left unset.

enrollment
Shop Click Enrollment · object

Optional electricity enrollment details collected before a lead_gen handoff — used to fill the offer's URL template (ESIID, start date, move vs switch) so the partner prefills its signup flow.

Response

Click recorded