Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Upsert Records Using sObject Collections

Use a PATCH request with sObject Collections to either create or update (upsert) up to 200 records based on an external ID field. This method returns a list of UpsertResult objects. You can choose whether to roll back the entire request when an error occurs. This request is available in API version 46 and later.

The list can contain up to 200 objects.
The list can contain objects only of the type indicated in the request URI.
Each object in the request body must contain an attributes map. The map must contain a value for type.
Using sObject Collections to insert blob data requires more values in the attributes map. For more information, see Using sObject Collections to Insert a Collection of Blob Records.
Note
Objects are created or updated in the order they’re listed in the request body. The UpsertResult objects are returned in the same order.
Only external ids are supported. Don’t use record ids.

If the request isn’t well formed, the API returns a 400 Bad Request HTTP Status. Fix the syntax of the request and try again. If the request is well formed, the API returns a 200 OK HTTP Status. If an item was processed successfully, the success flag shows for that item. Error information is returned in the errors array.

Syntax

URI: /services/data/vXX.X/composite/sobjects/SobjectName/ExternalIdFieldName

Formats: JSON, XML

HTTP Method: PATCH

Authentication: Authorization: Bearer token

Parameters

Parameter	Description
allOrNone	Optional. Indicates whether to roll back the entire request when the creation of any object fails (`true`) or to continue with the independent creation of other objects in the request. The default is `false`.
records	Required. A list of sObjects. In a PATCH request using sObject Collections, set the `type` attribute for each object. Don’t set the `id` field for any object. Instead, use the external ID field specified in the request URI.

Note: If the sObject Collections request is embedded in a Composite request, the Composite request’s allOrNone parameter can also affect the results. See allOrNone Parameters in Composite and Collections Requests.

Example

Example Request

1curl -X PATCH https://MyDomainName.my.salesforce.com/services/data/v67.0/composite/sobjects/Account/MyExtId__c -H "Authorization: Bearer token" -H "Content-Type: application/json" -d "@exampleRequestBody.json"

Example Request Body

1{
2    "allOrNone" : false,
3    "records" : [{
4        "attributes" : {"type" : "Account"},
5        "Name" : "Company One",
6        "MyExtId__c" : "AAA"
7    }, {
8        "attributes" : {"type" : "Account"},
9        "Name" : "Company Two",
10        "MyExtId__c" : "BBB"
11    }]
12}

Example Response Body

1HTTP/1.1 200 OK
2[
3    {
4        "id": "001xx0000004GxDAAU",
5        "success": true,
6        "errors": [],
7        "created": true
8    },
9    {
10        "id": "001xx0000004GxEAAU",
11        "success": true,
12        "errors": [],
13        "created": false
14    }
15]

Example Response Body (Some Items Failed and allOrNone is false)

1HTTP/1.1 200 OK
2
3[
4   {
5      "id" : "001xx0000004GxDAAU",
6      "success" : true,
7      "errors" : [ ]
8   },
9   {
10      "success" : false,
11      "errors" : [
12         {
13            "statusCode" : "MALFORMED_ID",
14            "message" : "Contact ID: id value of incorrect type: 001xx0000004GxEAAU",
15            "fields" : [
16               "Id"
17            ]
18         }
19      ]
20   }
21]

Example Response Body (Some Items Failed and allOrNone is true)

1HTTP/1.1 200 OK
2
3[
4   {
5      "id" : "001xx0000004GxDAAU",
6      "success" : false,
7      "errors" : [
8         {
9            "statusCode" : "ALL_OR_NONE_OPERATION_ROLLED_BACK",
10            "message" : "Record rolled back because not all records were valid and the request was using AllOrNone header",
11            "fields" : [ ]
12         }
13      ]
14   },
15   {
16      "success" : false,
17      "errors" : [
18         {
19            "statusCode" : "MALFORMED_ID",
20            "message" : "Contact ID: id value of incorrect type: 001xx0000004GxEAAU",
21            "fields" : [
22               "Id"
23            ]
24         }
25      ]
26   }
27]

REST API Developer Guide

Upsert Records Using sObject Collections

Syntax

Example

See Also