Update Object
1 min
PATCH
https://api.nue.io/api/objects/{objectName}/{id}
Path Parameters
- objectNamestringrequiredDescriptionAllowedCustomerOpportunityQuoteQuoteLineItemOrderOrderProduct
- idstringrequiredExampleDescription
Body Parameters
- bodyobjectrequiredExamplesActivate Order:
{ "status": "Activated" }Update Order Details:{ "description": "Updated order description", "poNumber": "PO-2025-001", "poDate": "2025-01-15" }Update Customer:{ "phone": "+1-555-9876", "billingStreet": "456 New Street", "billingCity": "Los Angeles" }Update Opportunity:{ "stage": "Negotiation", "probability": 75, "closeDate": "2025-03-15" }Update Quote:{ "status": "Approved", "subscriptionStartDate": "2025-06-01", "expirationDate": "2025-12-31" }Update Quote Line Item:{ "quantity": 10, "discount": 15, "description": "Updated line item" }Update Order Product:{ "quantity": 15, "description": "Updated quantity" }Description- objectCustomerUpdateRequest
- namestringDescription
- emailstringDescription
- phonestringDescription
- industrystringDescription
- billingStreetstringDescription
- billingCitystringDescription
- billingStatestringDescription
- billingPostalCodestringDescription
- billingCountrystringDescription
- billCycleDaystringDescription
- paymentTermstringDescription
- paymentMethodstringDescription
- descriptionstringDescription
- objectOpportunityUpdateRequest
- namestringDescription
- stagestringDescription
- closeDatestring<date>DescriptionFormatdate
- accountIdstringDescription
- probabilitynumberDescription
- descriptionstringDescription
- nextStepstringDescription
- discountAmountnumberDescription
- discountPercentagenumberDescription
- subscriptionStartDatestring<date>DescriptionFormatdate
- subscriptionEndDatestring<date>DescriptionFormatdate
- subscriptionTermnumberDescription
- primaryQuoteIdstringDescription
- objectQuoteUpdateRequest
- namestringDescription
- descriptionstringDescription
- statusstringDescription
- expirationDatestring<date>DescriptionFormatdate
- subscriptionStartDatestring<date>DescriptionFormatdate
- subscriptionEndDatestring<date>DescriptionFormatdate
- subscriptionTermnumberDescription
- isPrimaryQuotebooleanDescription
- contactIdstringDescription
- billingAccountIdstringDescription
- emailstringDescription
- phonestringDescription
- partnerPayoutPercentagenumberDescription
- partnerPayoutAmountnumberDescription
- paymentMethodstringDescription
- paymentTermstringDescription
- autoRenewbooleanDescription
- billingStreetstringDescription
- billingCitystringDescription
- billingStatestringDescription
- billingPostalCodestringDescription
- billingCountrystringDescription
- objectQuoteLineItemUpdateRequest
- quantitynumberDescription
- discountnumberDescription
- discountAmountnumberDescription
- descriptionstringDescription
- listPricenumberDescription
- unitPricenumberDescription
- subscriptionStartDatestring<date>DescriptionFormatdate
- subscriptionEndDatestring<date>DescriptionFormatdate
- subscriptionTermnumberDescription
- autoRenewbooleanDescription
- billingPeriodstringDescription
- billingTimingstringDescription
- paymentTermstringDescription
- objectOrderUpdateRequest
- statusstringExampleDescription
- namestringDescription
- descriptionstringDescription
- poNumberstringDescription
- poDatestring<date>DescriptionFormatdate
- billingPeriodstringDescription
- billCycleDaynumberDescription
- partnerPayoutPercentagenumberDescription
- partnerPayoutAmountnumberDescription
- paymentMethodstringDescription
- objectOrderProductUpdateRequest
- quantitynumberDescription
- discountnumberDescription
- discountAmountnumberDescription
- descriptionstringDescription
Responses
200
400
- ErrorResponseDescription
- codeintegerExampleDescription
- messagestringExampleDescription
- detailsstringExampleDescription
401
403
404
curl
curl --request PATCH \
--url https://api.nue.io/api/objects/{objectName}/{id} \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'PATCH',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.nue.io/api/objects/{objectName}/{id}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.nue.io/api/objects/{objectName}/{id}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.nue.io/api/objects/{objectName}/{id}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("PATCH", url, headers=headers, data=payload)
print(response.text)
200
// Object updated successfully
400
// Bad Request - Invalid data or field validation error
{
"code": 400,
"message": "Bad Request",
"details": "Required field 'name' is missing"
}401
// Unauthorized - Invalid or missing API key
403
// Forbidden - Insufficient permissions
404
// Not Found - Record with specified ID not found