REST API Developer Guide

Introduction to REST API
Quick Start
Examples
Generating an OpenAPI 3.0 Document for sObjects REST API (Beta)
Reference
Versions
Resources by Version
Limits
Describe Global
sObject Basic Information
sObject Describe
sObject Get Deleted
sObject Get Updated
sObject Named Layouts
sObject Rows
sObject Rows by External ID
sObject Blob Get
sObject ApprovalLayouts
sObject Single Approval Process
sObject CompactLayouts
sObject Layouts
sObject Layouts for an Object With Multiple Record Types
sObject Global Publisher Layouts
sObject PlatformAction
sObject Quick Actions
sObject Specific Quick Actions
sObject Quick Action Details
sObject Quick Action Default Values
sObject Quick Action Default Values by ID
sObject Rich Text Image Get
sObject Relationships
sObjects Suggested Articles
sObjects Suggested Articles by ID
sObject User Password
sObject Self-Service User Password
Platform Event Schema by Event Name
Platform Event Schema by Schema ID
Get AppMenu Types
AppMenu Items
AppMenu Mobile Items
Compact Layouts
Consent
Consent Write
Embedded Service Configuration Describe
Invocable Actions
Invocable Actions Custom
Invocable Actions Standard
List View Basic Information
List View Describe
List View Results
List Views for an Object
Named Query APIs for SOQL Queries
Support Knowledge with REST API
Parameterized Search
Portability
Process Approvals
Process Rules
Process Rule for an sObject
Process Rule List for an sObject
Product Schedules
Query
Query More Results
QueryAll
QueryAll More Results
Query Performance Feedback (Beta)
Quick Actions
Recent List Views
Recently Viewed Items
Record Count
sObject Relevant Items
Get Knowledge Language Settings
Search
Search Scope and Order
Search Result Layouts
Lightning Toggle Metrics
Lightning Usage by App Type
Lightning Usage by Browser
Lightning Usage by Page
Lightning Usage by FlexiPage
Lightning Exit by Page Metrics
Salesforce Scheduler Resources
Search for Records Suggested by Autocomplete and Instant Results
Search Suggested Article Title Matches
Search Suggested Queries
Salesforce Surveys Translation Resources
Tabs
Themes
Composite
Composite Graph
Composite Batch
Batch Request Body
Batch Response Body
sObject Tree
sObject Collections
PDF

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.

Composite Batch

Executes up to 25 subrequests in a single request. The response bodies and HTTP statuses of the subrequests in the batch are returned in a single response body. Each subrequest counts against rate limits.

The requests in a batch are called subrequests. All subrequests are executed in the context of the same user. Subrequests are independent, and you can’t pass information between them. Subrequests execute serially in their order in the request body. When a subrequest executes successfully, it commits its data. Commits are reflected in the output of later subrequests. If a subrequest fails, commits made by previous subrequests aren’t rolled back. If a batch request doesn’t complete within 10 minutes, the batch times out and the remaining subrequests aren’t executed.

Batching for the following resources and resource groups is available in API version 34.0 and later.
  • Limits—/services/data/vXX.X/limits
  • sObject resources (except sObject Blob Retrieve and sObject Rich Text Image Retrieve)—/services/data/vXX.X/sobjects/
  • Query—/services/data/vXX.X/query/?q=soql
  • QueryAll—/services/data/vXX.X/queryAll/?q=soql
  • Search—/services/data/vXX.X/search/?q=sosl
  • Connect resources—/services/data/vXX.X/connect/
  • Chatter resources—/services/data/vXX.X/chatter/
Batching for the following resources and resource groups is available in API version 35.0 and later.
  • Actions—vXX.X/actions

The API version of the resource accessed in each subrequest must be no earlier than 34.0 and no later than the Batch version in the top-level request. For example, if you post a Batch request to /services/data/v35.0/composite/batch, you can include subrequests that access version 34.0 or 35.0 resources. But if you post a Batch request to /services/data/v34.0/composite/batch, you can only include subrequests that access version 34.0 resources.

Syntax

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

Formats: JSON, XML

HTTP method: POST

Authentication: Authorization: Bearer token

Parameters: None required

Request body: Batch Request Body

Response body: Batch Response Body

Example

For an example of using the Composite Batch resource, see Update a Record and Get Its Field Values in a Single Request.