Update a Record

User Interface API enforces Salesforce validation rules. If a validation rule fails, the response is an Error with Output.

When you make a PATCH request to update a record, make sure that the record hasn’t changed since the user started editing it. To find out whether it’s safe to save a record, pass the If-Unmodified-Since HTTP header in the request.

As of API version 43.0, if you pass read-only fields in a request body, the response is an Error with Output.

1/ui-api/records/{recordId}

Available Version

41.0

HTTP Method

PATCH

Example

This example passes a request body to update the name of an Account.

1PATCH /ui-api/records/001R0000003Gjrt

1{
2    "fields": {
3    "Name": "Universal Containers"
4  }
5}

To provide an address, provide the individual fields as separate inputs. The compound field is only available in the response.

1{
2    "fields" : {
3    "Name": "Local Boxes",
4    "BillingState": "WA",
5    "BillingStreet" : "123 Main Street",
6    "BillingCountry" : "USA"
7  }
8}

Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
allowSaveOnDuplicate	Boolean	Specifies whether to save a duplicate record. The default value is false.	Optional	43.0
handleOwnerChange	Boolean	Specifies whether to return a 204 No Content HTTP status code if the context user loses access to the record during the update. The default value is false. When false, if the context user loses access to the record during the update, the update completes successfully, however the resource returns an incorrect 404 Not found HTTP status code.	Optional	60.0
includeFieldsInBody	Boolean	Specifies whether to return a field that’s defined in the request body but not in the layout. The default value is false. When set to true, fields that are not in the layout are also included in the response body.	Optional	59.0
triggerOtherEmail	Boolean	For a Case, specifies whether to send email to users outside the organization. In the Salesforce user interface, this email can be triggered by creating, editing, or deleting a contact for a Case. The default value is false. See EmailHeader in SOAP API Developer Guide.	Optional	51.0
triggerUserEmail	Boolean	For a Case or a Lead, specifies whether to send email to users in the organization. In the Salesforce user interface, this email can be triggered by various events: resetting a password, creating a user, changing the Case owner, or adding comments to a Case. For Case owner changes, also set useDefaultRule=true, or no email is sent. The default value is false. See EmailHeader in SOAP API Developer Guide.	Optional	51.0
useDefaultRule	Boolean	For a Case or Lead, specifies whether to use the default (active) assignment rule. If you specify useDefaultRule, don’t specify an assignmentRuleId. For an Account, specifies whether to apply the default territory assignment rules. The default value is false. See AssignmentRuleHeader in SOAP API Developer Guide.	Optional	51.0

Request Body

Name	Type	Description	Required or Optional	Available Version
allowSaveOnDuplicate	Boolean	Specifies whether to save a duplicate record (true), or not (false). The default value is false.	Optional	43.0
apiName	String	To create a record, specify the API name of an Object from which to create the record. To update a record, use null or don’t pass this property.	Required to create a record.	41.0
fields	Map<String, Object>	Map of field names to field values. Format data types according to these rules: Address—JSON String. Addresses are compound fields and must be broken up into their constituent fields. See the previous example. Boolean—JSON Boolean, true or false Currency—JSON Number (for example, 67.54) Date—JSON string (for example, 2020-04-20) DateTime—JSON string in ISO 8601 format (for example, 2012-02-18T06:40:41.000Z) Double—JSON Number Email—JSON String (for example, joe@smith.com) EncryptedString—JSON String Int—JSON Number Location—JSON String. Location fields are compound fields and must be broken up into their constituent fields. MultiPicklist—JSON String (for example, Dog;Cat;Fish). Percent—JSON Number Phone—JSON String Picklist—JSON String Reference—JSON String String—JSON String TextArea—JSON String Time—JSON String in format HH:MM:SS Url—JSON String To specify the main record type, either don’t specify the RecordTypeId field, or set it to null.	Required	41.0

Response Body

Record