Boost V2 Integration

Create Agent Promo Campaign

Create a social media ad campaign to promote an agent's services

get/dashboard/integration/promo_campaign/{partner_short_code}

Request

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

Path parameters

partner_short_codestring required

Partner identifier assigned by Boost

Query parameters

first_namestring required

First name of the agent

last_namestring required

Last name of the agent

emailstring email required

Email address of the agent

phonestring

Phone number of the agent

agent_imgstring uri

URL to agent's photo for the ad

facebook_page_idstring

Facebook page ID (must be in HomeSpotter Business Manager)

headlinestring

URL-encoded ad headline

titlestring

URL-encoded ad title

descriptionstring

URL-encoded ad description

broker_namestring

URL-encoded brokerage name

landing_page_urlstring uri

URL for ad landing page

tokenstring required

JWT authentication token

Response

Successfully created agent promo campaign

Changes

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