Skip to main content
POST
Create a new report

Authorizations

Authorization
string
header
required

API key authentication. Include your API key in the Authorization header:

Body

application/json
address
string
required

Property street address

city
string
state
string
zip
string
price
number

Listing price in dollars

beds
integer
baths
number
sqft
integer
year_built
integer
property_type
string

e.g., "Single Family", "Condo", "Townhouse"

lot_size
number
description
string
zpid
string

Zillow property ID

zillow_url
string<uri>
mls_id
string
status
string
default:For Sale
is_draft
boolean
default:true
custom_agent_name
string
custom_agent_email
string<email>
custom_agent_phone
string
listing_agent
string

Name of the listing agent. If not provided, defaults to the team admin/account owner's name.

created_by
string

Name of the person who created the report. If not provided, defaults to the team name (from the team associated with the API key).

custom_logo_url
string<uri>
primary_brand_color
string

Hex color code

secondary_brand_color
string

Hex color code

Response

Report created successfully

data
object
message
string