Add estimate option

Add a named option with its own line items to a draft estimate.

POST https://cotlet.dev/api/v1/housecall-pro/estimates/{estimate_id}/option

write

Adds one option, with its own line items and total, to an estimate, the same as + New option on the Estimate details page. It reaches no one: the option stays on the estimate until send_estimate runs. Remove an option in Housecall Pro from the three-dot menu on its tab, Delete. add_estimate_option runs without asking first for that reason.

Parameters

Parameters: add_estimate_option
NameTypeDescription
estimate_id string required string Estimate ID from list_estimates or create_estimate.
name string required string Option name, for example 'Better'.
line_items object[] required object[] Lines to add: name, quantity and unit_price, or price_book_id from list_price_book. A line that names a price book item uses its price unless you set unit_price.

Request

cURL
curl -X POST https://cotlet.dev/api/v1/housecall-pro/estimates/est_8e41c2/option \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Tankless unit","line_items":[{"name":"Tankless water heater, installed","quantity":1,"unit_price":3900}]}'
Python
result = client.call("housecall-pro", "add_estimate_option", {"estimate_id":"est_8e41c2","name":"Tankless unit","line_items":[{"name":"Tankless water heater, installed","quantity":1,"unit_price":3900}]})
Node.js
const result = await cotlet.call('housecall-pro', 'add_estimate_option', {"estimate_id":"est_8e41c2","name":"Tankless unit","line_items":[{"name":"Tankless water heater, installed","quantity":1,"unit_price":3900}]});
CLI
cotlet call housecall-pro add_estimate_option --data '{"estimate_id":"est_8e41c2","name":"Tankless unit","line_items":[{"name":"Tankless water heater, installed","quantity":1,"unit_price":3900}]}'

Example response

JSON

{
  "estimate_id": "est_8e41c2",
  "option_id": "opt_3",
  "name": "Tankless unit",
  "line_items": [
    {
      "name": "Tankless water heater, installed",
      "quantity": 1,
      "unit_price": 3900
    }
  ],
  "total": 3900
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.