Batch Job Actions

A Batch Management job processes a flow in manageable parts. For more information about running an active Batch Management jobs, see Schedule a Batch Job in Salesforce Help.

This object is available in API version 51.0 and later.

Supported REST HTTP Methods

URI

/services/data/vXX.X/actions/custom/batchJobAction

Formats

JSON

HTTP Methods

GET, POST

Authentication

Authorization: Bearer token

Inputs

The batch job action uses the batch job definition ID and input variables to execute the job and generate a batch job ID. The input values vary according to the input variables in that flow.

Outputs

Usage

JSON Sample Request

1{
2   "noOfEmployees" : 900,
3   "accountIndustry" : "Technology"
4}

JSON Sample Response

1{
2   "batchJobId": "0lMxx0000A000001EAA"
3   "accepted": "true"
4}