Update a Record

Update a record's data.

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 Body

Name	Type	Description	Required or Optional	Available Version
`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	41.0
`fields`	Map<String, Object>	Map of field names to field values. Format data types according to these rules: `Address`—JSON String `Base64`—JSON String `Boolean`—JSON Boolean, `true` or `false` `Currency`—JSON Float `Date`—JSON string in correct format `DateTime`—JSON string in ISO 8601 format `Double`—JSON Float `Email`—JSON String `EncryptedString`—JSON String `Int`—JSON Number `Location`—JSON String `MultiPicklist`—JSON String `Percent`—JSON Float `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	Required	41.0

Response Body

Record

User Interface API Developer Guide

Update a Record

See Also