Skip to main content
POST
Create budget estimate
Required scopes: sales_visualizer.use

Authorizations

Authorization
string
header
required

Use Authorization: Bearer rk_live_....

Headers

Idempotency-Key
string
required

A unique value for each new request, such as a UUID. Send the same value to retry a request safely. The same key and payload replay the first response with Idempotency-Replayed: true.

Required string length: 1 - 160

Body

application/json
address
string
required
Required string length: 3 - 500
Example:

"100 Congress Ave, Austin, TX 78701"

place_id
string | null

Google Places id. RoofKit uses it to locate the property when lat and lng are absent.

Maximum string length: 500
lat
number

Send with lng. Without both, RoofKit geocodes the address.

Required range: -90 <= x <= 90
lng
number
Required range: -180 <= x <= 180
selected_material_id
string | null
Maximum string length: 150
selected_shape_id
string | null
Maximum string length: 150
selected_color_id
string | null
Maximum string length: 150

Response

Budget Estimate created or replayed.

budget_estimate
object
required
input
object
required