Edit an existing estimate in your ConstructionOnline company account
https://api.constructiononline.com/api/v2/esimates?id={id}&estimateInfo={estimateInfo}
This endpoint allows users to edit an existing estimate within their ConstructionOnline company account. To update an estimate, users must know the unique numerical ID assigned to the estimate. The estimate's ID is stored in the estimate property 'ID'. Users should enter the properties to be updated in the URL of the request—specifically, in the "estimateInfo" request parameter. Only the properties specified in the parameter will be updated; the other properties will remain as is.
Individual estimate categories, subcategories, items, or company overhead and margin cannot be updated using this endpoint.
Requests
id: integer
- Unique identifier for the estimate.
estimateInfo: JSON
- Updated properties for the estimate.
- Allowed properties in estimateInfo: MARKUP_NAME, FIVE_COLUMN_ESTIMATE, ADVANCED_ESTIMATE, TOTAL_PRICE, LAST_QBD_ESTIMATE_DATE, LAST_QBD_ACTUAL_DATE, LAST_QBD_INVOICE_DATE, LAST_QBD_PO_DATE, TOTAL_QB_ACTUALS, TOTAL_QB_INVOICED, TOTAL_QB_COMMITTED
Sample request URL:
- https://api.constructiononline.com/api/v2/estimates?id=345678&estimateInfo={"TOTAL_PRICE":"349,000"}
Example requests in cURL, C#, Python, and JavaScript can be found below:
cURL
# replace {email} with the email address for your ConstructionOnline account
# {password} with your ConstructionOnline password
# {apikey} with your provided API key
# {id} with the estimate's ID
# {estimateInfo} with the updated properties
curl -X PUT https://api.constructiononline.com/api/v2/estimates?id={id}&estimateInfo={estimateInfo} -u {email}:{password} -H 'APIKey:{apikey}'
C#
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{id} with the estimate's ID
{estimateInfo} with the updated properties */
public string MakeRequest(string endpoint, string payload) {
string username = {username};
string password = {password};
string apiKey = {apikey};
string response = "";
var handler = new HttpClientHandler() { AutomaticDecompression = System.Net.DecompressionMethods.GZip };
using (HttpClient client = new HttpClient(handler)) {
client.BaseAddress = new Uri("http://api.constructiononline.com");
client.DefaultRequestHeaders.Accept.Clear();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", System.Convert.ToBase64String(System.Text.Encoding.GetEncoding("ISO-8859-1").GetBytes(username + ":" + password)));
client.DefaultRequestHeaders.Add("APIKey", apiKey);
client.DefaultRequestHeaders.Add("Accept-Encoding", "gzip");
HttpContent content = new StringContent(payload, System.Text.Encoding.UTF32, "application/json");
response = client.PutAsync(endpoint, content).Result.ToString();
}
return response;
}
MakeRequest("api/v2/estimates?id={id}&estimateInfo={estimateInfo}");
Python
#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{id} with the estimate's ID
#{estimateInfo} with the updated properties
import base64, requests, json
#Global Variables
apikey = {apikey}
username = {username}
password = {password}
#Functions
def makeRequest(endpoint, payload):
url = "https://api.constructiononline.com/" + endpoint
userPass = username + ":" + password
headers = {
"APIKey": apikey,
"Accept-Encoding": "gzip, deflate, br",
"Authorization": "Basic " + base64.b64encode(userPass.encode()).decode(),
}
response = requests.request("PUT", url, headers=headers, data=payload)
return json.dumps(json.loads(response.text), indent=2)
#Main Program
print(makeRequest("api/v2/estimates?id={id}&estimateInfo={estimateInfo}"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{id} with the estimate's ID
{estimateInfo} with the updated properties */
username = '{username}';
password = '{password}';
apikey = '{apikey}';
function makeRequest(endpoint, payload) {
auth = btoa('${username}:${password}');
var myHeaders = new Headers();
myHeaders.append("APIKey", apikey);
myHeaders.append("Accept-Encoding", "gzip, deflate, br");
myHeaders.append("Authorization", "Basic ${auth}");
var requestOptions = {
method: 'PUT',
body: '',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.constructiononline.com/" + endpoint, requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
return response;
};
makeRequest("api/v2/estimates?id={id}&estimateInfo={estimateInfo}");
Responses
200: Success
A successful request will return a 200 response with a record of the edited estimate in the body.
A sample response and property definitions can be found here.
404: Error
The server was not able to locate the resource specified in the request. The ID may have been entered incorrectly or an estimate with the entered ID does not exist.
429: Error
The user has surpassed the request rate limit for the hour, day, week, or month.
500: Error
There was an internal server error and the server was unable to complete the request.
Last updated: Mar 19, 2024