Run a Pipeline — Batch

POST{orgBaseUrl}/services/apexrest/pushtopics/execution/batch/pipeline/{pipelineApiName}

Path Parameters

Parameter	Type	Required	Description
pipelineApiName	string	Yes	API name of the Pipeline to run.

Request Body

Parameter	Type	Required	Description
additionalRetrieveParameters	string \| object	No	Additional filters for the Executables in the first Pipeline. As a string, one filter applies to every Executable. As a JSON object, each Executable API name maps to its own filter. Omit it when no additional filter is needed.
chainNextPipeline	boolean	No	Controls whether the Pipeline's configured Next Pipeline runs after the current Pipeline completes. Defaults to `false`.

Request Example

Filter the retrieved records and run the configured Pipeline chain:

json

{
  "additionalRetrieveParameters": "CreatedDate = TODAY",
  "chainNextPipeline": true
}

Apply a different filter to each Executable and run the configured Pipeline chain:

json

{
  "additionalRetrieveParameters": {
    "Account_Sync": "CreatedDate = TODAY",
    "Contact_Sync": "LastModifiedDate = LAST_N_DAYS:7"
  },
  "chainNextPipeline": true
}

Returns

Returns the ID of the submitted Pipeline Execution record. The returned ID confirms that the execution was submitted. It does not indicate that processing has finished.