Run an Executable — Sync

The Sync API isn't available for org-to-org Apex callouts due to Salesforce's cross-org callout restrictions — use the Batch API instead. If synchronous execution is required, route the call through a proxy web service hosted outside Salesforce that relays the request and response to the DSP hosting service.

POST{orgBaseUrl}/services/apexrest/pushtopics/execution/sync/executable/{executableApiName}

Path Parameters

Parameter	Type	Required	Description
executableApiName	string	Yes	API name of the Executable to run.

Request Body

Parameter	Type	Required	Description
sourceRecordIds	array of strings	Yes	IDs of records from the Executable's source object.

Request Example

json

{
  "sourceRecordIds": [
    "001XXXXXXXXXXXX"
  ]
}

Returns

Returns the processing result for each source record directly in the response body. Sync executions do not create Execution records.

json

[
    [
        {
            "targetId": "001XXXXXXXXXXXX",
            "success": true,
            "sourceId": "001XXXXXXXXXXXX",
            "skipped": false,
            "action": "insert"
        }
    ]
]

Field	Type	Description
sourceId	string	ID of the source record.
targetId	string	ID of the resulting target record.
success	boolean	Indicates whether the record was processed successfully.
skipped	boolean	Indicates whether the record was skipped.
action	string	Operation performed, such as `insert` or `update`.