Boost V2 Integration

Create Listing Campaign

Create a campaign for a real estate listing with optional dynamic listing creation

get/dashboard/integration/campaign/{partner_short_code}

Request

  • Base URL: https://boost.homespotter.com
  • URL: https://boost.homespotter.com/dashboard/integration/campaign/{partner_short_code}
  • Auth: API key in query parameter token

Path parameters

partner_short_codestring required

Query parameters

mls_idstring required

MLS ID of the listing

zipstring required

ZIP code of the listing

addressstring

Street address of the listing

citystring

City of the listing

statestring

State code of the listing

countrystring

Country of the listing

pricenumber double

Price of the listing

bedinteger

Number of bedrooms

bathnumber

Number of bathrooms

sqftinteger

Square footage of the listing

descstring

MLS description of the listing

latitudenumber double

Latitude for geo-targeting

longitudenumber double

Longitude for geo-targeting

status'new' | 'rent' | 'pending' | 'sold' | 'reducedprice' | 'closed'

Status of the listing

first_namestring

Agent first name (for new agents)

last_namestring

Agent last name (for new agents)

phonestring

Agent phone (for new agents)

emailstring email

Agent email (for new agents)

agent_imgstring uri

Agent photo URL (for new agents)

banner_colorstring

Hexadecimal color for status banner

broker_namestring

Broker name for the ad

listing_urlstring uri

URL where users land after clicking the ad

img_urlstring uri

URL to featured property image

facebook_page_idstring

Facebook page ID for posting the ad

tokenstring required

Response

Campaign created successfully

Changes

No recorded changes to this operation across all 1 revision of this API.