Create a proposal from estimates

Creates a draft proposal with one option per estimate in estimate_ids, so the homeowner can choose between the packages you priced. Options are ordered by when the estimates were made and named after each estimate's product kit (or its title when it has none). Each option carries a copy of every line item on its estimate, with prices and costs so margin stays visible, and records its source in source_estimate_id. Pass proposal_template_id to apply one of the company's active proposal templates; without it, the company's default template is applied, or the first active template by name when none is marked default.

You can combine one to five of the deal's estimates; void estimates are refused. When the deal has been won, pass the job's ID as job_id so the proposal belongs to that job from the start.

The token's role must be allowed to prepare estimates, and must either have access to all records or be the sales rep assigned to the lead.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
estimate_ids
array of uuids
required

1 to max_options of the deal's estimates

estimate_ids*
uuid

when created from a job: one of this lead's jobs, which the proposal belongs to from creation

uuid

one of the company's active proposal templates; leave it out for the default, or the first active template by name when none is marked default

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json