REST API Developer Guide

REST API
Quick Start
Examples
Generating an OpenAPI 3.0 Specification 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 Retrieve
sObject ApprovalLayouts
sObject CompactLayouts
sObject Describe Layouts
sObject PlatformAction
sObject Quick Actions
sObject Rich Text Image Retrieve
sObject Relationships
sObject Suggested Articles
sObject User Password
Platform Event Schema by Event Name
Platform Event Schema by Schema ID
AppMenu
Compact Layouts
Consent
Consent Write
Embedded Service Configuration Describe
Invocable Actions
List View Describe
List View Results
List Views
Support Knowledge with REST API
Parameterized Search
Portability
Process Approvals
Process Rules
Product Schedules
Query
QueryAll
Quick Actions
Recent List Views
Recently Viewed Items
Record Count
sObject Relevant Items
Retrieve 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 Resources
Composite
Composite Graphs
Composite Batch
sObject Tree
sObject Collections
Create Multiple Records with Fewer Round-Trips
Retrieve Multiple Records with Fewer Round-Trips
Update Multiple Records with Fewer Round-Trips
Upsert Multiple Records with Fewer Round-Trips
Delete Multiple Records with Fewer Round-Trips
Headers
Status Codes and Error Responses
PDF

Newer Version Available

This content describes an older version of this product. View Latest

sObject Collections

Executes actions on multiple records in one request. Use sObject Collections to reduce the number of round-trips between the client and server. The response bodies and HTTP statuses of the requests are returned in a single response body. The entire request counts as a single call toward your API limits. This resource is available in API version 42.0 and later.
URI
The URI to use depends on the operation.
Create
POST /services/data/vXX.X/composite/sobjects
Retrieve
GET /services/data/vXX.X/composite/sobjects/SobjectName?ids=recordId,recordId&fields=fieldname,fieldname
Update
PATCH /services/data/vXX.X/composite/sobjects
Upsert
PATCH /services/data/vXX.X/composite/sobjects/SobjectName/ExternalIdFieldName
Delete
DELETE /services/data/vXX.X/composite/sobjects?ids=recordId,recordId
Formats
JSON, XML
HTTP method
GET, DELETE, PATCH, POST
Authentication
Authorization: Bearer token

The parameters, request body, and response body you use depend on the operation. For details, see the specific operation.