Sign in

v1

latestOpenAPI 3.0.22026-07-141713124.8 KB
Offers

Marketplace Deeplink

post/plans/link

Query parameters

wattkeystring

Our identifier for this home

addressstring

The street address of the property

citystring

City of the property

statestring

State of the property as a two letter code (e.g. "TX")

zipstring required

5-digit zip code of the property

category'community_solar' | 'demand_response' | 'ev_chargers' | 'heat_pump' | 'heat_pump_water_heater' | 'light_bulbs' | 'rooftop_solar' | 'smart_plugs' | 'smart_thermostat'

The category of offers to return. All offers will be returned if category is not present.

property_idstring

Property ID associated with the customer

Request body

first_namestring

Customer first name

last_namestring

Customer last name

emailstring

Customer email address, required when redirect_url is provided

phone_numberstring

Customer phone number

dobstring

MM/DD/YYYY

redirect_urlstring uri

URL to redirect to after saving. Customer ID will be appended as user_id query parameter (optional)

service_start_datestring

MM/DD/YYYY

service_type'switch' | 'move'
utm_campaignstring

UTM campaign tracking parameter. Appended to the response URL.

utm_termstring

UTM term tracking parameter. Appended to the response URL.

utm_contentstring

UTM content tracking parameter. Appended to the response URL.

Response

OK

urlstring

The response URL. When redirect_url is provided, returns that URL with user_id and any utm_campaign/utm_term/utm_content params appended. Otherwise returns a wattbuy marketplace deeplink built from the address params with utm params appended.

user_idstring nullable

Unique customer identifier. null if no customer info was provided.