Creates a CRM Analytics dataflow job, which is the equivalent of clicking Run Now for a data prep recipe, a data sync, or a dataflow in the CRM Analytics Data Manager UI. For more information on the different IDs that are used to start a job, see Run, Schedule, and Sync CRM Analytics Data with REST APIs.

createDataflowJob uses this CRM Analytics API resource.

  • dataflowId— (Required) The dataflow, data prep recipe, or data sync ID for the job.

  • command— (Required) The job command to execute.

    • start
    • stop

    Must be start to create a dataflow job.

A Promise object that resolves with the Dataflow Job response.

There are several ways to use createDataflowJob. For example, you can display a list of recipes and enable start on each recipe on the list.

This example adds a start button to a page with recipes. Starting a recipe displays a toast message using the lightning/platformShowToastEvent module.

This button calls the createDataflowJob() method.