Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Salesforce Batch API
description: 'Find the resources you need to start building. '
contact: {}
version: '1.0'
servers:
- url: https://login.salesforce.com
variables: {}
- url: https://id
variables: {}
- url: https://services
variables: {}
- url: '{{url}}{{site}}/services/oauth2'
variables:
url:
default: DefaultParameterValue
site:
default: DefaultParameterValue
security:
- oauth2:
- api
tags:
- name: Batch
paths:
/async/64.0/job//batch:
parameters: []
post:
tags:
- Batch
summary: Salesforce Bulk Create Batch
operationId: BulkCreateBatch
parameters:
- name: X-SFDC-Session
in: header
description: ''
required: true
schema:
type: string
example: example_value
- name: Content-Type
in: header
description: ''
required: true
schema:
const: text/csv
type: string
examples:
- text/csv
example: example_value
- name: charset
in: header
description: ''
required: true
schema:
type: string
examples:
- UTF-8
example: example_value
requestBody:
content:
multipart/form-data:
encoding: {}
schema:
required:
- File
type: object
properties:
File:
type: string
contentEncoding: base64
contentMediaType: multipart/form-data
examples:
BulkcreatebatchRequestExample:
summary: Default BulkCreateBatch request
x-microcks-default: true
value:
File: example_value
required: false
responses:
'201':
description: Created
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Thu, 16 Nov 2023 16:16:10 GMT
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: max-age=63072000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-XSS-Protection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 1; mode=block
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
Location:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: /services/async/58.0/job/7502o00000kjNCsAAM/batch/7512o00001DSJWnAAP
Content-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: gzip
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/batchInfo'
- xml:
name: batchInfo
attribute: false
wrapped: false
examples:
- "<batchInfo>\n\n <id>751...</id>\n\n <jobId>750...</jobId>\n\n <state>Queued</state>\n\n <createdDate>datetime</createdDate>\n\n <systemModstamp>datetime</systemModstamp>\n\n <numberRecordsProcessed>0</numberRecordsProcessed>\n\n <numberRecordsFailed>0</numberRecordsFailed>\n\n <totalProcessingTime>0</totalProcessingTime>\n\n <apiActiveProcessingTime>0</apiActiveProcessingTime>\n\n <apexProcessingTime>0</apexProcessingTime>\n\n</batchInfo>"
contentMediaType: application/xml
example: "<batchInfo>\n\n <id>751...</id>\n\n <jobId>750...</jobId>\n\n <state>Queued</state>\n\n <createdDate>datetime</createdDate>\n\n <systemModstamp>datetime</systemModstamp>\n\n <numberRecordsProcessed>0</numberRecordsProcessed>\n\n <numberRecordsFailed>0</numberRecordsFailed>\n\n <totalProcessingTime>0</totalProcessingTime>\n\n <apiActiveProcessingTime>0</apiActiveProcessingTime>\n\n <apexProcessingTime>0</apexProcessingTime>\n\n</batchInfo>"
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
tags:
- Batch
summary: Salesforce Bulk Check Batch Status
operationId: BulkCheckBatchStatus
parameters:
- name: X-SFDC-Session
in: header
description: ''
required: true
schema:
type: string
example: example_value
- name: Accept-Encoding
in: header
description: ''
required: true
schema:
type: string
examples:
- gzip
example: example_value
- name: Content-Encoding
in: header
description: ''
required: true
schema:
type: string
examples:
- gzip
example: example_value
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Thu, 16 Nov 2023 16:19:29 GMT
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: max-age=63072000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-XSS-Protection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 1; mode=block
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
Content-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: gzip
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/batchInfoList'
- xml:
name: batchInfoList
attribute: false
wrapped: false
examples:
- "<batchInfoList>\n\n <batchInfo>\n\n <id>751...</id>\n\n <jobId>750...</jobId>\n\n <state>Completed</state>\n\n <createdDate>datetime</createdDate>\n\n <systemModstamp>datetime</systemModstamp>\n\n <numberRecordsProcessed>1</numberRecordsProcessed>\n\n <numberRecordsFailed>0</numberRecordsFailed>\n\n <totalProcessingTime>403</totalProcessingTime>\n\n <apiActiveProcessingTime>225</apiActiveProcessingTime>\n\n <apexProcessingTime>64</apexProcessingTime>\n\n </batchInfo>\n\n</batchInfoList>"
contentMediaType: application/xml
example: "<batchInfoList>\n\n <batchInfo>\n\n <id>751...</id>\n\n <jobId>750...</jobId>\n\n <state>Completed</state>\n\n <createdDate>datetime</createdDate>\n\n <systemModstamp>datetime</systemModstamp>\n\n <numberRecordsProcessed>1</numberRecordsProcessed>\n\n <numberRecordsFailed>0</numberRecordsFailed>\n\n <totalProcessingTime>403</totalProcessingTime>\n\n <apiActiveProcessingTime>225</apiActiveProcessingTime>\n\n <apexProcessingTime>64</apexProcessingTime>\n\n </batchInfo>\n\n</batchInfoList>"
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/async/64.0/job//batch/{_batchId}/result:
parameters: []
get:
tags:
- Batch
summary: Salesforce Bulk Retrieve Batch Result
operationId: BulkRetrieveBatchResult
parameters:
- name: X-SFDC-Session
in: header
description: ''
required: true
schema:
type: string
example: example_value
- name: Accept-Encoding
in: header
description: ''
required: true
schema:
type: string
examples:
- gzip
example: example_value
- name: Content-Encoding
in: header
description: ''
required: true
schema:
type: string
examples:
- gzip
example: example_value
- name: _batchId
in: path
description: ''
required: true
schema:
type: string
example: '500123'
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Thu, 16 Nov 2023 16:20:11 GMT
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: max-age=63072000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-XSS-Protection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 1; mode=block
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
Content-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: gzip
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
text/csv:
schema:
type: string
examples:
- '"Id","Success","Created","Error"
"001...","true","true",""
'
contentMediaType: text/csv
example: '"Id","Success","Created","Error"
"001...","true","true",""
'
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/async/64.0/job//batch/{_batchId}/result/{batchResultId}:
parameters: []
get:
tags:
- Batch
summary: Salesforce Bulk Retrieve Batch Result Data
operationId: BulkRetrieveBatchResultData
parameters:
- name: batchResultId
in: path
description: ''
required: true
schema:
type: string
examples:
- 'null'
example: '500123'
- name: X-SFDC-Session
in: header
description: ''
required: true
schema:
type: string
example: example_value
- name: Accept-Encoding
in: header
description: ''
required: true
schema:
type: string
examples:
- gzip
example: example_value
- name: Content-Encoding
in: header
description: ''
required: true
schema:
type: string
examples:
- gzip
example: example_value
- name: _batchId
in: path
description: ''
required: true
schema:
type: string
example: '500123'
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Thu, 16 Nov 2023 16:36:36 GMT
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: max-age=63072000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-XSS-Protection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 1; mode=block
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
Content-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: gzip
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
text/csv; charset=UTF-8:
schema:
type: string
examples:
- '"Id","Name"
"001...","GenePoint"
"001...","United Oil & Gas, UK"
"001...","United Oil & Gas, Singapore"
"001...","Edge Communications"
"001...","Burlington Textiles Corp of America"
"001...","Pyramid Construction Inc."
"001...","Dickenson plc"
"001...","Grand Hotels & Resorts Ltd"
"001...","Express Logistics and Transport"
"001...","University of Arizona"
"001...","United Oil & Gas Corp."
"001...","sForce"
"001...","Exemple de comptes pour les autorisations"
"001...","Tom Jones"
'
contentMediaType: text/csv; charset=UTF-8
example: '"Id","Name"
"001...","GenePoint"
"001...","United Oil & Gas, UK"
"001...","United Oil & Gas, Singapore"
"001...","Edge Communications"
"001...","Burlington Textiles Corp of America"
"001...","Pyramid Construction Inc."
"001...","Dickenson plc"
"001...","Grand Hotels & Resorts Ltd"
"001...","Express Logistics and Transport"
"001...","University of Arizona"
"001...","United Oil & Gas Corp."
"001...","sForce"
"001...","Exemple de comptes pour les autorisations"
"001...","Tom Jones"
'
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/data/v64.0/composite/batch:
parameters: []
post:
tags:
- Batch
summary: Salesforce Composite Batch
description: '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 are not rolled back. If a batch request doesn’t complete within 10 minutes, the batch times out and the remaining subrequests aren’t executed.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_batch.htm'
operationId: CompositeBatch
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/CompositeBatchRequest'
- examples:
- haltOnError: true
batchRequests:
- method: GET
url: v64.0/query/?q=SELECT+Id,+Name+FROM+Account LIMIT 2
- method: GET
url: v64.0/query/?q=SELECT+Id,+Name+FROM+Opportunity LIMIT 2
contentMediaType: application/json
example:
haltOnError: true
batchRequests:
- method: GET
url: v64.0/query/?q=SELECT+Id,+Name+FROM+Account LIMIT 2
- method: GET
url: v64.0/query/?q=SELECT+Id,+Name+FROM+Opportunity LIMIT 2
required: true
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Mon, 20 Nov 2023 15:19:46 GMT
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: max-age=63072000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-XSS-Protection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 1; mode=block
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
Sforce-Limit-Info:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: api-usage=34/15000
Vary:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Accept-Encoding
Content-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: gzip
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
application/json;charset=UTF-8:
schema:
type: string
examples:
- "{\n \"hasErrors\": false,\n \"results\": [\n {\n \"statusCode\": 200,\n \"result\": {\n \"totalSize\": 2,\n \"done\": true,\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001...\"\n },\n \"Id\": \"001...\",\n \"Name\": \"Sample Account\"\n },\n ...\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"result\": {\n \"totalSize\": 2,\n \"done\": true,\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"Opportunity\",\n \"url\": \"/services/data/v58.0/sobjects/Opportunity/006...\"\n },\n \"Id\": \"006...\",\n \"Name\": \"Edge Emergency Generator\"\n },\n ...\n ]\n }\n }\n ]\n}"
contentMediaType: application/json;charset=UTF-8
example: "{\n \"hasErrors\": false,\n \"results\": [\n {\n \"statusCode\": 200,\n \"result\": {\n \"totalSize\": 2,\n \"done\": true,\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"Account\",\n \"url\": \"/services/data/v58.0/sobjects/Account/001...\"\n },\n \"Id\": \"001...\",\n \"Name\": \"Sample Account\"\n },\n ...\n ]\n }\n },\n {\n \"statusCode\": 200,\n \"result\": {\n \"totalSize\": 2,\n \"done\": true,\n \"records\": [\n {\n \"attributes\": {\n \"type\": \"Opportunity\",\n \"url\": \"/services/data/v58.0/sobjects/Opportunity/006...\"\n },\n \"Id\": \"006...\",\n \"Name\": \"Edge Emergency Generator\"\n },\n ...\n ]\n }\n }\n ]\n}"
deprecated: false
servers:
- url: https://services
variables: {}
x-api-evangelist-processing:
PascalCaseOperationSummaries: true
ChooseTags: true
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/data/v64.0/chatter/feed-elements/batch:
parameters: []
post:
tags:
- Batch
summary: Salesforce Feed Elements, Batch Post
description: 'Post a batch of up to 500 feed elements.
https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_feed_element_batch_post.htm'
operationId: FeedElements,BatchPost
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/FeedElementsBatchPostRequest'
examples:
Feedelements,batchpostRequestExample:
summary: Default FeedElements,BatchPost request
x-microcks-default: true
value:
inputs:
- {}
required: true
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Wed, 22 Nov 2023 11:11:25 GMT
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: max-age=63072000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: nosniff
X-XSS-Protection:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: 1; mode=block
X-Robots-Tag:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: none
Cache-Control:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: no-cache,must-revalidate,max-age=0,no-store,private
Vary:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Accept-Encoding
Content-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: gzip
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/SuccessfulFeedElementsBatchPost'
- examples:
- hasErrors: true
results:
- result:
actor:
additionalLabel: null
communityNickname: User1696423780773910041
companyName: Salesforce
displayName: Name
firstName: Firstname
id: 005...
isActive: true
isInThisCommunity: true
lastName: Name
motif:
color: 1B96FF
largeIconUrl: /img/icon/profile64.png
mediumIconUrl: /img/icon/profile32.png
smallIconUrl: /img/icon/profile16.png
svgIconUrl: null
mySubscription: null
name: Name
outOfOffice:
message: ''
photo:
fullEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1
largePhotoUrl: https://<my_domain>/profilephoto/729.../F
mediumPhotoUrl: https://<my_domain>/profilephoto/729.../M
photoVersionId: 729...
smallPhotoUrl: https://<my_domain>/profilephoto/729.../T
standardEmailPhotoUrl: https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?fromEmail=1
url: /services/data/v58.0/connect/user-profiles/005.../photo
reputation: null
title: null
type: User
url: /services/data/v58.0/chatter/users/005...
userType: Internal
body:
isRichText: false
messageSegments:
- text: Post Number 1
type: Text
text: Post Number 1
capabilities:
associatedActions:
platformActionGroups: []
bookmarks:
isBookmarkedByCurrentUser: false
chatterLikes:
isLikedByCurrentUser: false
likesMessage: null
myLike: null
page:
currentPageToken: 0
currentPageUrl: /services/data/v58.0/chatter/feed-elements/0D5.../capabilities/chatter-likes/items
items: []
nextPageToken: null
nextPageUrl: null
previousPageToken: null
previousPageUrl: null
total: 0
close:
canContextUserUpdateIsClosed: tr
# --- truncated at 32 KB (176 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-batch-api-openapi.yml