--- title: Update Object slug: update-object docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "IIf3RALuYR2fgx9Tr0aqp", "type": "api-oas-v2", "data": { "method": "PATCH", "url": "https://api.nue.io/api/objects/{objectName}/{id}", "servers": [ { "url": "https://api.nue.io/api/objects/{objectName}/{id}", "description": "Nue Production API Endpoint" }, { "url": "https://api.sandbox.nue.io/api/objects/{objectName}/{id}", "description": "Nue Sandbox API Endpoint" } ], "name": "Update Object", "description": "

Update an existing record in Salesforce using partial update (PATCH). Only include fields you want to change. Supports Customer, Opportunity, Quote, QuoteLineItem, Order, and OrderProduct objects.

\n

Important: This is a metadata-driven API. The fields available for each object are determined by your Salesforce metadata configuration and permissions. The examples shown are common fields, but your actual available fields may vary. Some fields may be read-only based on your permissions.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "objectName", "type": "string", "description": "The object type to update", "enum": [ "Customer", "Opportunity", "Quote", "QuoteLineItem", "Order", "OrderProduct" ] }, { "kind": "required", "name": "id", "type": "string", "example": "801Em000011N4dNIAS", "description": "The Salesforce ID of the record to update" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "Fields to update. Only include fields you want to change.", "schema": [], "complexItems": [ { "name": "object", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "Account name" }, { "name": "email", "kind": "optional", "type": "string", "description": "Primary contact email" }, { "name": "phone", "kind": "optional", "type": "string", "description": "Phone number" }, { "name": "industry", "kind": "optional", "type": "string", "description": "Industry classification" }, { "name": "billingStreet", "kind": "optional", "type": "string", "description": "Billing street address" }, { "name": "billingCity", "kind": "optional", "type": "string", "description": "Billing city" }, { "name": "billingState", "kind": "optional", "type": "string", "description": "

Billing state/province

" }, { "name": "billingPostalCode", "kind": "optional", "type": "string", "description": "Billing postal code" }, { "name": "billingCountry", "kind": "optional", "type": "string", "description": "Billing country" }, { "name": "billCycleDay", "kind": "optional", "type": "string", "description": "Day of month for billing cycle" }, { "name": "paymentTerm", "kind": "optional", "type": "string", "description": "Payment terms" }, { "name": "paymentMethod", "kind": "optional", "type": "string", "description": "Default payment method" }, { "name": "description", "kind": "optional", "type": "string", "description": "Account description" } ], "modelRef": "#/components/schemas/CustomerUpdateRequest", "customType": "CustomerUpdateRequest" }, { "name": "object", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "Opportunity name" }, { "name": "stage", "kind": "optional", "type": "string", "description": "

Current opportunity stage (e.g., Prospecting, Negotiation, Closed Won)

" }, { "name": "closeDate", "kind": "optional", "type": "string", "description": "Expected close date", "format": "date" }, { "name": "accountId", "kind": "optional", "type": "string", "description": "Customer account ID" }, { "name": "probability", "kind": "optional", "type": "number", "description": "

Confidence percentage (0-100)

" }, { "name": "description", "kind": "optional", "type": "string", "description": "Text description of the opportunity" }, { "name": "nextStep", "kind": "optional", "type": "string", "description": "Next step in the sales process" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Total discretional discount amount" }, { "name": "discountPercentage", "kind": "optional", "type": "number", "description": "Discretional discount percentage" }, { "name": "subscriptionStartDate", "kind": "optional", "type": "string", "description": "Start date for products or services", "format": "date" }, { "name": "subscriptionEndDate", "kind": "optional", "type": "string", "description": "End date for products or services", "format": "date" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "Length of the subscription" }, { "name": "primaryQuoteId", "kind": "optional", "type": "string", "description": "ID of the primary quote for this opportunity" } ], "modelRef": "#/components/schemas/OpportunityUpdateRequest", "customType": "OpportunityUpdateRequest" }, { "name": "object", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "Quote name" }, { "name": "description", "kind": "optional", "type": "string", "description": "Quote description" }, { "name": "status", "kind": "optional", "type": "string", "description": "

Quote status (e.g., Draft, Approved)

" }, { "name": "expirationDate", "kind": "optional", "type": "string", "description": "Quote expiration date", "format": "date" }, { "name": "subscriptionStartDate", "kind": "optional", "type": "string", "description": "Subscription start date", "format": "date" }, { "name": "subscriptionEndDate", "kind": "optional", "type": "string", "description": "Subscription end date", "format": "date" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "Subscription term length" }, { "name": "isPrimaryQuote", "kind": "optional", "type": "boolean", "description": "Whether this is the primary quote" }, { "name": "contactId", "kind": "optional", "type": "string", "description": "Contact ID" }, { "name": "billingAccountId", "kind": "optional", "type": "string", "description": "Billing account ID" }, { "name": "email", "kind": "optional", "type": "string", "description": "Email address" }, { "name": "phone", "kind": "optional", "type": "string", "description": "Phone number" }, { "name": "paymentMethod", "kind": "optional", "type": "string", "description": "Payment method" }, { "name": "paymentTerm", "kind": "optional", "type": "string", "description": "Payment terms" }, { "name": "autoRenew", "kind": "optional", "type": "boolean", "description": "

Auto-renewal flag

" }, { "name": "billingStreet", "kind": "optional", "type": "string", "description": "Billing street address" }, { "name": "billingCity", "kind": "optional", "type": "string", "description": "Billing city" }, { "name": "billingState", "kind": "optional", "type": "string", "description": "

Billing state/province

" }, { "name": "billingPostalCode", "kind": "optional", "type": "string", "description": "Billing postal code" }, { "name": "billingCountry", "kind": "optional", "type": "string", "description": "Billing country" } ], "modelRef": "#/components/schemas/QuoteUpdateRequest", "customType": "QuoteUpdateRequest" }, { "name": "object", "schema": [ { "name": "quantity", "kind": "optional", "type": "number", "description": "Line item quantity" }, { "name": "discount", "kind": "optional", "type": "number", "description": "Discount percentage" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Discount amount" }, { "name": "description", "kind": "optional", "type": "string", "description": "Line item description" }, { "name": "listPrice", "kind": "optional", "type": "number", "description": "List price per unit" }, { "name": "unitPrice", "kind": "optional", "type": "number", "description": "Sales price per unit" }, { "name": "subscriptionStartDate", "kind": "optional", "type": "string", "description": "Subscription start date", "format": "date" }, { "name": "subscriptionEndDate", "kind": "optional", "type": "string", "description": "Subscription end date", "format": "date" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "Subscription term" }, { "name": "autoRenew", "kind": "optional", "type": "boolean", "description": "

Auto-renewal flag

" }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "Billing period" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "Billing timing" }, { "name": "paymentTerm", "kind": "optional", "type": "string", "description": "Payment terms" } ], "modelRef": "#/components/schemas/QuoteLineItemUpdateRequest", "customType": "QuoteLineItemUpdateRequest" }, { "name": "object", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "

Order status (e.g., Draft, Activated)

", "example": "Activated" }, { "name": "name", "kind": "optional", "type": "string", "description": "Order name" }, { "name": "description", "kind": "optional", "type": "string", "description": "Order description" }, { "name": "poNumber", "kind": "optional", "type": "string", "description": "Purchase order number" }, { "name": "poDate", "kind": "optional", "type": "string", "description": "Purchase order date", "format": "date" }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "Billing period" }, { "name": "billCycleDay", "kind": "optional", "type": "number", "description": "Bill cycle day" }, { "name": "paymentMethod", "kind": "optional", "type": "string", "description": "Payment method" } ], "modelRef": "#/components/schemas/OrderUpdateRequest", "customType": "OrderUpdateRequest" }, { "name": "object", "schema": [ { "name": "quantity", "kind": "optional", "type": "number", "description": "Line item quantity" }, { "name": "discount", "kind": "optional", "type": "number", "description": "Discount percentage" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "Discount amount" }, { "name": "description", "kind": "optional", "type": "string", "description": "Line item description" } ], "modelRef": "#/components/schemas/OrderProductUpdateRequest", "customType": "OrderProductUpdateRequest" } ], "complexType": "oneOf", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "ApiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Object updated successfully", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "

Bad Request - Invalid data or field validation error

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Error response", "customType": "ErrorResponse", "schema": [ { "name": "code", "kind": "optional", "type": "integer", "description": "HTTP status code", "example": 400 }, { "name": "message", "kind": "optional", "type": "string", "description": "Error message", "example": "Bad Request" }, { "name": "details", "kind": "optional", "type": "string", "description": "Detailed error information", "example": "Required field 'name' is missing" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "

Unauthorized - Invalid or missing API key

", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "

Forbidden - Insufficient permissions

", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "

Not Found - Record with specified ID not found

", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "XcZCjQxSGHJGOtMp7df_N", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url https://api.nue.io/api/objects/{objectName}/{id} \\\n --header 'accept: application/json'" }, { "id": "EW5SB6uJozjkoEnkNAc63", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/api/objects/{objectName}/{id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "6IBxZH0aC-k_vh65Wgf4j", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/api/objects/{objectName}/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "VgyfitKiDEB_vELX6si0a", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/api/objects/{objectName}/{id}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "XcZCjQxSGHJGOtMp7df_N" }, "results": { "languages": [ { "id": "HJJsI5RJ5SZxPMP3e3U5L", "language": "200", "code": "// Object updated successfully\n" }, { "id": "aA82ezsqEYFkX5hRacKLN", "language": "400", "code": "// Bad Request - Invalid data or field validation error\n{\n \"code\": 400,\n \"message\": \"Bad Request\",\n \"details\": \"Required field 'name' is missing\"\n}" }, { "id": "z1nfMzkeD73WQ1uZQ_gHt", "language": "401", "code": "// Unauthorized - Invalid or missing API key\n" }, { "id": "Dxiyr3_c2cEhxp-tRnghQ", "language": "403", "code": "// Forbidden - Insufficient permissions\n" }, { "id": "EMqSEvY0HasDgf8HKIGln", "language": "404", "code": "// Not Found - Record with specified ID not found\n" } ], "selectedLanguageId": "HJJsI5RJ5SZxPMP3e3U5L" } }, "children": [ { "text": "" } ] }