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.

Send Multiple Requests Using Composite

Executes a series of REST API requests in a single call. You can use the output of one request as the input to a subsequent request. The response bodies and HTTP statuses of the requests are returned in a single response body. The entire series of requests counts as a single call toward your API limits.

The sObject Blob Get and sObject Rich Text Image Get APIs return  binary data. These APIs aren’t supported in a Composite API request.

Note

The requests in a composite call are called subrequests. All subrequests are executed in the context of the same user. In a subrequest’s body, you specify a reference ID that maps to the subrequest’s response. You can then refer to the ID in the url or body fields of later subrequests by using a JavaScript-like reference notation.

For example, the following composite request body includes two subrequests. The first creates an account and designates the output as refAccount. The second creates a contact parented under the new account by referencing refAccount in the subrequest body.

1{
2"compositeRequest" : [{
3  "method" : "POST",
4  "url" : "/services/data/v67.0/sobjects/Account",
5  "referenceId" : "refAccount",
6  "body" : { "Name" : "Sample Account" }
7  },{
8  "method" : "POST",
9  "url" : "/services/data/v67.0/sobjects/Contact",
10  "referenceId" : "refContact",
11  "body" : { 
12    "LastName" : "Sample Contact",
13    "AccountId" : "@{refAccount.id}"
14    }
15  }]
16}

You can specify whether an error in a subrequest causes the whole composite request to roll back or just the subrequests that depend on it. You can also specify headers for each subrequest.

Composite is supported for the following resources.

All sObject resources (/services/data/vXX.X/sobjects/), including sObject Rows by External ID and excluding sObject Blob Get
The Query resource (/services/data/vXX.X/query/?q=soql)
The QueryAll resource (/services/data/vXX.X/queryAll/?q=soql)
The sObject Collections resource (/services/data/vXX.X/composite/sobjects). Available in API version 43.0 and later.

You can have up to 25 subrequests in a single call. Up to 5 of these subrequests can be sObject Collections or query operations, including Query and QueryAll requests.

Note

Syntax

URI: /services/data/vXX.X/composite

Formats: JSON

HTTP method: POST

Authentication: Authorization: Bearer token

Parameters: None required

Request body: Composite Request Body

Response body: Composite Response Body

Example

For examples of using the Composite resource, see Execute Dependent Requests in a Single API Call and Update an Account, Create a Contact, and Link Them with a Junction Object.

REST API Developer Guide

Send Multiple Requests Using Composite

Syntax

Example