Batch Record Input

A description of multiple operations for a request to create, update, or delete a batch of records.

Example

1POST /ui-api/records/batch

1{
2  "allOrNone": false,
3  "operations": [
4    {
5      "type": "CREATE",
6      "records": [
7        {
8          "apiName": "Account",
9          "fields": {
10            "Name": "ACCOUNT 1"
11          }
12        },
13        {
14          "apiName": "Contact",
15          "fields": {
16            "LastName": "Smith"
17          }
18        }
19      ]
20    },
21    {
22      "type": "Update",
23      "records": [
24        {
25          "fields": {
26            "Id": "001xx000003Gaf9AAC",
27            "NumberOfEmployees": 1000
28          }
29        }
30      ]
31    },
32    {
33      "type": "Delete",
34      "records": [
35        {
36          "fields": {
37            "Id": "001xx000003GanDAAS"
38          }
39        }
40      ]
41    }
42  ]
43}

Properties

Name	Type	Description	Required or Optional	Available Version
`allOrNone`	Boolean	Specifies whether to stop processing the request and rollback any changes when the request encounters an error. The default is `true`.	Optional	59.0
`operations`	Batch Operation Input []	A description of records and operation types.	Required	59.0

User Interface API Developer Guide

Batch Record Input