---
title: "Marketplace Deeplink"
method: POST
path: "/plans/link"
tags: ["Offers"]
---

# Marketplace Deeplink

`POST /plans/link`

## Request

- Base URL: `https://apis.wattbuy.com/v3`
- URL: `https://apis.wattbuy.com/v3/plans/link`
- Auth: API key in header `x-api-key`

## Query parameters

- `wattkey` string
- `address` string
- `city` string
- `state` string
- `zip` string, required
- `category` 'community_solar' | 'demand_response' | 'ev_chargers' | 'heat_pump' | 'heat_pump_water_heater' | 'light_bulbs' | 'rooftop_solar' | 'smart_plugs' | 'smart_thermostat'
- `property_id` string

## Request body

- Customer
  - `first_name` string: Customer first name
  - `last_name` string: Customer last name
  - `email` string: Customer email address, required when `redirect_url` is provided
  - `phone_number` string: Customer phone number
  - `dob` string: MM/DD/YYYY
  - `redirect_url` string, uri: URL to redirect to after saving. Customer ID will be appended as user_id query parameter (optional)
  - `service_start_date` string: MM/DD/YYYY
  - `service_type` 'switch' | 'move'
  - `utm_campaign` string: UTM campaign tracking parameter. Appended to the response URL.
  - `utm_term` string: UTM term tracking parameter. Appended to the response URL.
  - `utm_content` string: UTM content tracking parameter. Appended to the response URL.

## Response `200`

OK

- object
  - `url` string: 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_id` string, nullable: Unique customer identifier. `null` if no customer info was provided.

## Other responses

- `204`: Plans are not available
- `400`: Bad request
- `500`: Internal server error

---

[API](https://skmtc.dev/wattbuy/apis/wattbuy-apis.md) - [All operations](https://skmtc.dev/wattbuy/apis/wattbuy-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/wattbuy/apis/wattbuy-apis/revisions/443ce1657edb?raw)
