Refer to Schema for the set of attributes that can be updated for each entity. Below are the points to keep in mind while updating an attribute.
- Clear out an existing value as shown in the below table by passing either null or empty values.
Data Type | Null | Empty |
Number | null | 0 |
String | null | “” |
Array | null | [] |
Object | null | {} |
- Update any field individually, without the need to send any other fields
Data Type | Update Approach |
Number | Pass a number |
String | Pass a string |
Array | Pass the entire elements in the array. If an element is missed out while sending the array, then that element will be updated to null |
Standard Object | Pass the entire elements in the object. If an element is missed out while sending the object, then that element will be updated to null. For example:
Option 1 – Passing all elements. { "width": { "value": 20, "unit": "cm" }, }
Option 2 – Passing partial elements, in this case value element will be set to null. { "width": { "unit": "cm" }, }
|
Custom Field Object | If custom fields are enabled for this entity, then you can update individual fields. Not required to pass all custom fields in the object as part of update.
For example, if there are 3 custom fields enabled (cf1, cf2, cf3), you can still update the customFields object with value for any one of the custom fields – cf1 or cf2 or cf3. No need to pass all fields, unless all 3 need to be updated.
{ "customFields": { "cf1": [ "value1" ], "cf2": [ "value1" ], "cf3": [ "value1" ], } }
Option 1: Below will update only cf1 field, and will not make any changes to the other 2 fields – cf2 and cf3
{ "customFields": { "cf1": [ "Updated Value" ], } }
|