Create an empty proposal

Creates a draft proposal with option_count empty options, named "Option 1", "Option 2" and so on, ready for you to fill with PATCH /agreements/{id}. option_count must be between 1 and 5. 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. 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
integer
required
≥ 1

1 to max_options; the options are named Option 1, Option 2 and so on

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