Send a proposal or contract to the homeowner

Sends a draft proposal or contract to the deal's contact, or sends an already-sent one again. Sending a draft sets its status to sent, sets valid_until to 30 days out when you have not set one, locks it against further edits, logs the send on the deal, and prepares its PDF in the background.

The homeowner gets a link to view, accept or sign the document: by email when the contact has an email address and has not opted out, and by text when texting is set up for the company and the contact has a phone number and has not opted out. The response reports each channel separately in email_delivery and sms_delivery. queued means the message is on its way; any other value, such as no_email, no_phone, opted_out or not_configured, means it was not sent that way. Show the user when neither channel delivered.

Estimates cannot be sent this way and are refused with 403; use POST /estimates/{id}/send_to_contact. At least one option must be set to be sent. 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 deal.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Responses

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