openapi: 3.1.0
info:
title: Salesforce Bulk API 2.0 Abort Update API
description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.
'
version: v63.0
contact:
name: Salesforce Developers
url: https://developer.salesforce.com/
license:
name: Salesforce Developer Terms
url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
description: Salesforce Bulk API 2.0 jobs endpoint
variables:
instance:
default: yourInstance
description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).
'
version:
default: '63.0'
description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.
'
security:
- BearerAuth: []
tags:
- name: Update
paths:
/data/v64.0/composite/sobjects:
parameters: []
patch:
tags:
- Update
summary: Salesforce Sobject Collections Update
description: 'Executes actions on multiple records in one request. Use SObject Collections to reduce the number of round-trips between the client and server. This resource is available in API version 42.0 and later.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_sobjects_collections.htm'
operationId: SObjectCollectionsUpdate
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/SObjectCollectionsUpdateRequest'
- examples:
- allOrNone: false
records:
- attributes:
type: Account
id: <account-id>
NumberOfEmployees: 27000
contentMediaType: application/json
example:
allOrNone: false
records:
- attributes:
type: Account
id: <account-id>
NumberOfEmployees: 27000
required: true
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Mon, 20 Nov 2023 15:28:31 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=46/15000
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
application/json;charset=UTF-8:
schema:
type: array
items:
$ref: '#/components/schemas/SObjectCollectionsUpdate'
description: ''
examples:
- - id: 001...
success: true
errors: []
contentMediaType: application/json;charset=UTF-8
example:
- id: 001...
success: true
errors: []
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/named-credentials/credential:
parameters: []
put:
tags:
- Update
summary: Salesforce Update Credential
description: Update a credential.
operationId: UpdateCredential
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateCredentialRequest'
- examples:
- externalCredential: test
authenticationProtocol: Custom
principalName: test
principalType: NamedPrincipal
credentials:
testCredential:
value: '000000'
encrypted: true
contentMediaType: application/json
example:
externalCredential: test
authenticationProtocol: Custom
principalName: test
principalType: NamedPrincipal
credentials:
testCredential:
value: '000000'
encrypted: true
required: true
responses:
'200':
description: ''
headers: {}
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/named-credentials/external-credentials/{DEVELOPER_NAME}:
parameters: []
put:
tags:
- Update
summary: Salesforce Update External Credential
description: Update an external credential.
operationId: UpdateExternalCredential
parameters:
- name: DEVELOPER_NAME
in: path
description: ''
required: true
schema:
type: string
example: example_value
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateExternalCredentialRequest'
- examples:
- masterLabel: Sample External Credential
authenticationProtocol: Custom
principals:
- principalName: SamplePrincipal
principalType: NamedPrincipal
sequenceNumber: 1
customHeaders:
- headerName: SampleHeader
headerValue: SampleHeaderValue
sequenceNumber: 1
contentMediaType: application/json
example:
masterLabel: Sample External Credential
authenticationProtocol: Custom
principals:
- principalName: SamplePrincipal
principalType: NamedPrincipal
sequenceNumber: 1
customHeaders:
- headerName: SampleHeader
headerValue: SampleHeaderValue
sequenceNumber: 1
required: true
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Mon, 20 Nov 2023 16:55:19 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
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/SuccessfulUpdateExternalCredential'
- examples:
- authenticationProtocol: Custom
authenticationStatus: Unknown
customHeaders:
- headerName: SampleHeader
headerValue: SampleHeaderValue
id: 0pu2o000000KymkAAC
sequenceNumber: 1
developerName: SampleExternalCredential
id: 0pt2o000000CaU0AAK
masterLabel: Sample External Credential
parameters: []
principals:
- authenticationStatus: Unknown
id: 0pu2o000000KymjAAC
parameters: []
principalAccess: []
principalName: SamplePrincipal
principalType: NamedPrincipal
sequenceNumber: 1
relatedNamedCredentials:
- developerName: SamplePrivate
id: 0XA2o000000XaAQGA0
masterLabel: SamplePrivateLabel
url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
contentMediaType: application/json;charset=UTF-8
example:
authenticationProtocol: Custom
authenticationStatus: Unknown
customHeaders:
- headerName: SampleHeader
headerValue: SampleHeaderValue
id: 0pu2o000000KymkAAC
sequenceNumber: 1
developerName: SampleExternalCredential
id: 0pt2o000000CaU0AAK
masterLabel: Sample External Credential
parameters: []
principals:
- authenticationStatus: Unknown
id: 0pu2o000000KymjAAC
parameters: []
principalAccess: []
principalName: SamplePrincipal
principalType: NamedPrincipal
sequenceNumber: 1
relatedNamedCredentials:
- developerName: SamplePrivate
id: 0XA2o000000XaAQGA0
masterLabel: SamplePrivateLabel
url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
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/named-credentials/named-credential-setup/{DEVELOPER_NAME}:
parameters: []
put:
tags:
- Update
summary: Salesforce Update Named Credential
description: Update a named credential.
operationId: UpdateNamedCredential
parameters:
- name: DEVELOPER_NAME
in: path
description: ''
required: true
schema:
type: string
example: example_value
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateNamedCredentialRequest'
- examples:
- masterLabel: SamplePrivateLabel
type: SecuredEndpoint
calloutUrl: https://api.example.com
externalCredentials:
- developerName: SampleExternalCredential
customHeaders:
- headerName: SampleHeader
headerValue: SampleValue
sequenceNumber: 1
calloutOptions:
allowMergeFieldsInBody: false
allowMergeFieldsInHeader: true
generateAuthorizationHeader: true
contentMediaType: application/json
example:
masterLabel: SamplePrivateLabel
type: SecuredEndpoint
calloutUrl: https://api.example.com
externalCredentials:
- developerName: SampleExternalCredential
customHeaders:
- headerName: SampleHeader
headerValue: SampleValue
sequenceNumber: 1
calloutOptions:
allowMergeFieldsInBody: false
allowMergeFieldsInHeader: true
generateAuthorizationHeader: true
required: true
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Mon, 20 Nov 2023 16:54:57 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
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/SuccessfulUpdateNamedCredential'
- examples:
- calloutOptions:
allowMergeFieldsInBody: false
allowMergeFieldsInHeader: true
generateAuthorizationHeader: true
calloutUrl: https://api.example.com
customHeaders:
- headerName: SampleHeader
headerValue: SampleValue
id: 0pv2o000000PAv6AAG
sequenceNumber: 1
developerName: SamplePrivate
externalCredentials:
- developerName: SampleExternalCredential
id: 0pt2o000000CaU0AAK
masterLabel: Sample External Credential
url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
id: 0XA2o000000XaAQGA0
masterLabel: SamplePrivateLabel
parameters: []
type: SecuredEndpoint
url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
contentMediaType: application/json;charset=UTF-8
example:
calloutOptions:
allowMergeFieldsInBody: false
allowMergeFieldsInHeader: true
generateAuthorizationHeader: true
calloutUrl: https://api.example.com
customHeaders:
- headerName: SampleHeader
headerValue: SampleValue
id: 0pv2o000000PAv6AAG
sequenceNumber: 1
developerName: SamplePrivate
externalCredentials:
- developerName: SampleExternalCredential
id: 0pt2o000000CaU0AAK
masterLabel: Sample External Credential
url: /services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential
id: 0XA2o000000XaAQGA0
masterLabel: SamplePrivateLabel
parameters: []
type: SecuredEndpoint
url: /services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate
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/tooling/sobjects/NamedCredential/{NAMED_CREDENTIAL_ID}:
parameters: []
patch:
tags:
- Update
summary: Salesforce Update Named Credential
operationId: Updatenamedcredential
parameters:
- name: NAMED_CREDENTIAL_ID
in: path
description: ''
required: true
schema:
type: string
examples:
- 'null'
example: '500123'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdatenamedcredentialRequest1'
- examples:
- FullName: MyNamedCredential
Metadata:
label: My Named Credential
endpoint: arn:aws:AWS_REGION:AWS_ACCOUNT_ID
principalType: Anonymous
protocol: NoAuthentication
contentMediaType: application/json
example:
FullName: MyNamedCredential
Metadata:
label: My Named Credential
endpoint: arn:aws:AWS_REGION:AWS_ACCOUNT_ID
principalType: Anonymous
protocol: NoAuthentication
required: true
responses:
'200':
description: ''
headers: {}
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/connect/business-rules/expression-set/{expressionSetId}:
parameters: []
patch:
tags:
- Update
summary: Salesforce Expression Set Update
description: "# Expression Set Update (PATCH)\n\nEndpoints to read, and update expression set.Resource\n\n```\n/connect/business-rules/expression-set/${expressionSetId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect\n /business-rules/expressionSet/$11Oxx0000006PcLEAU\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nDELETE, GET, PATCH\n\nResponse body for GET\n\n[Expression Set Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_output.htm)\n\nRequest body for PATCH\n\nRoot XML tag\n\nJSON example\n\n```\n{\n \"name\": \"CTX Mapping ES\",\n \"apiName\": \"CTX_Mapping_ES_1\",\n \"description\": \"...\",\n \"usageType\": \"Bre\",\n \"contextDefinitions\": [\n {\n \"id\": \"11Oxx0000006PcLEAU\"\n }\n ],\n \"versions\": [\n {\n \"name\": \"CTX_Mapping_ES_1 V1\",\n \"apiName\": \"CTX_Mapping_ES_1_V1\",\n \"description\": \"Sample CTX Mapping\",\n \"startDate\": \"2022-11-14T20:31:47.000+0000\",\n \"endDate\": \"2022-11-14T20:31:47.000+0000\",\n \"versionNumber\": 1,\n \"rank\": 1,\n \"enabled\": true,\n \"showExplExternally\": false,\n \"steps\": [\n {\n \"name\": \"Condition1\",\n \"description\": \"Condition step for conditions w.r.t product\",\n \"sequenceNumber\": 1,\n \"resultIncluded\": true,\n \"stepType\": \"Condition\",\n \"conditionExpression\": {\n \"expression\": \"productName == 'iPhone' && productColor == 'Red'\",\n \"resultParameter\": \"condition_output__1\"\n }\n }\n ],\n \"variables\": [\n {\n \"name\": \"productName\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productName\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"productColor\",\n \"collection\": false,\n \"dataType\": \"Text\",\n \"description\": \"productColor\",\n \"input\": true,\n \"output\": false,\n \"type\": \"Variable\"\n },\n {\n \"name\": \"condition_output__1\",\n \"dataType\": \"Boolean\",\n \"description\": \"condition_output__1\",\n \"input\": false,\n \"output\": true,\n \"resultStep\": \"Condition1\",\n \"type\": \"Variable\"\n }\n ]\n }\n ]\n}\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| apiName | String | Unique name of the expression set. | Required | 58.0 |\n| contextDefinitions | [Context Definition Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_context_definition_input.htm) | List of context definitions in an expression set. | Optional | 58.0 |\n| description | String | Description of the expression set. | Optional | 58.0 |\n| name | String | Name of the expression set. | Required | 58.0 |\n| usageType | String | Usage type of the expression set.<br><br>Valid values are:<br><br>- AiAcceleratorSubscriberChurnPrediction—Used for Industries Einstein<br> <br>- Bre—Used for Business Rules Engine<br> <br>- CustomLoyalty—Used for Loyalty Management<br> <br>- DefaultPricing—Used for Pricing Plans in Enterprise Product Catalog (EPC) by Communications Cloud<br> <br>- Qualification—Used for Industries Communications, Media, and Energy (CME)<br> <br>- RecordAlert—Used for Financial Services Cloud<br> <br>- ShipAndDebit—Used for Manufacturing Cloud<br> <br>- TierProcessing—Used for Loyalty Management<br> <br>- TransactionJournal—Used for Loyalty Management<br> <br>- WarrantyClaim—Used for Manufacturing Cloud | Required | 58.0 |\n| versions | [Expression Set Version Input](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_requests_expression_set_version.htm)\\[\\] | List of the expression set versions. | Optional | 58.0 |\n\nResponse body for PATCH\n\n[Expression Set Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_expression_set_output.htm)"
operationId: ExpressionSetUpdate
parameters:
- name: expressionSetId
in: path
description: 'Expression Set Id: For Example 9QLHo000000LBjEOAW'
required: true
schema:
type: string
examples:
- 9QLHo000000LBjJOAW
example: '500123'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ExpressionSetUpdateRequest'
- examples:
- apiName: myExpressionSet
contextDefinitions: []
name: myExpressionSet2
usageType: Bre
versions:
- apiName: myExpressionSet_V1
enabled: false
id: 9QMHo000000LBjOOAW
name: myExpressionSet V1
showExplExternally: false
startDate: '2023-09-06T10:35:11.000Z'
steps: []
variables: []
versionNumber: 1
contentMediaType: application/json
example:
apiName: myExpressionSet
contextDefinitions: []
name: myExpressionSet2
usageType: Bre
versions:
- apiName: myExpressionSet_V1
enabled: false
id: 9QMHo000000LBjOOAW
name: myExpressionSet V1
showExplExternally: false
startDate: '2023-09-06T10:35:11.000Z'
steps: []
variables: []
versionNumber: 1
required: true
responses:
'200':
description: OK
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Wed, 06 Sep 2023 10:48:19 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
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
application/json;charset=UTF-8:
schema:
allOf:
- $ref: '#/components/schemas/Status200-SuccessfullyUpdated'
- examples:
- apiName: myExpressionSet
contextDefinitions: []
id: 9QLHo000000LBjJOAW
name: myExpressionSet2
usageType: Bre
versions:
- apiName: myExpressionSet_V1
enabled: false
id: 9QMHo000000LBjOOAW
name: myExpressionSet V1
showExplExternally: false
startDate: '2023-09-06T10:35:11.000Z'
steps: []
variables: []
versionNumber: 1
contentMediaType: application/json;charset=UTF-8
example:
apiName: myExpressionSet
contextDefinitions: []
id: 9QLHo000000LBjJOAW
name: myExpressionSet2
usageType: Bre
versions:
- apiName: myExpressionSet_V1
enabled: false
id: 9QMHo000000LBjOOAW
name: myExpressionSet V1
showExplExternally: false
startDate: '2023-09-06T10:35:11.000Z'
steps: []
variables: []
versionNumber: 1
'400':
description: Bad Request
headers:
Date:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: Wed, 06 Sep 2023 10:44:53 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
Transfer-Encoding:
content:
text/plain:
schema:
type: string
contentMediaType: text/plain
example: chunked
content:
application/json;charset=UTF-8:
schema:
type: array
items:
$ref: '#/components/schemas/Status400-UnrecognizedBodyField1'
description: ''
examples:
- - errorCode: JSON_PAR
# --- truncated at 32 KB (257 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-update-api-openapi.yml