Update Objects

the update objects api allows you to update existing records in salesforce through nue's revenue lifecycle api this endpoint provides partial updates (patch) to customer, order, and orderproduct records required permission your api key must be associated with a role that has manage salesforce orders permission enabled under the "nue on salesforce" category endpoint patch /api/objects/{objectname}/{id} supported objects object description customer update customer accounts (maps to salesforce account) order update order records and status orderproduct update order line items important metadata driven fields the fields available for each object are determined by your salesforce metadata configuration and permissions the fields documented below are common examples and may vary based on your organization's setup to see the exact fields available for your environment use the /docs/api references/metadata api to retrieve object definitions check your salesforce org's field configurations some fields may be read only or have update restrictions based on your permissions authentication include your api key in the request header curl x patch 'https //api nue io/api/objects/order/801em000011n4dnias' \\ h 'nue api key your api key' \\ h 'content type application/json' update order update an existing order, such as changing its status activate an order curl x patch 'https //api nue io/api/objects/order/801em000011n4dnias' \\ h 'nue api key your api key' \\ h 'content type application/json' \\ d '{ "status" "activated" }' update order fields curl x patch 'https //api nue io/api/objects/order/801em000011n4dnias' \\ h 'nue api key your api key' \\ h 'content type application/json' \\ d '{ "description" "updated order description", "ponumber" "po 2025 001", "podate" "2025 01 15" }' updatable order fields (examples) the following fields are commonly updatable your actual fields depend on your metadata configuration and permissions field type description status string order status (e g , "draft", "activated") description string order description ponumber string purchase order number podate date purchase order date response a successful update returns http 200 with an empty body update customer update an existing customer account request curl x patch 'https //api nue io/api/objects/customer/001d000000irfmaiah' \\ h 'nue api key your api key' \\ h 'content type application/json' \\ d '{ "phone" "+1 555 9876", "billingstreet" "456 new street", "billingcity" "los angeles", "billingstate" "ca" }' updatable customer fields (examples) the following fields are commonly updatable your actual fields depend on your metadata configuration and permissions field type description name string account name email string primary contact email phone string phone number industry string industry classification billingstreet string billing street address billingcity string billing city billingstate string billing state/province billingpostalcode string billing postal code billingcountry string billing country shippingstreet string shipping street address shippingcity string shipping city shippingstate string shipping state/province shippingpostalcode string shipping postal code shippingcountry string shipping country billcycleday string day of month for billing cycle paymentterm string payment terms paymentmethod string default payment method description string account description update order product update an existing order line item request curl x patch 'https //api nue io/api/objects/orderproduct/802d000000iz4abcd' \\ h 'nue api key your api key' \\ h 'content type application/json' \\ d '{ "quantity" 15, "description" "updated quantity" }' updatable order product fields (examples) the following fields are commonly updatable your actual fields depend on your metadata configuration and permissions field type description quantity number line item quantity discount number discount percentage discountamount number discount amount description string line item description subscriptionstartdate date subscription start date subscriptionenddate date subscription end date subscriptionterm number subscription term