Updates a CRM Analytics dataflow job, which is the equivalent of clicking Stop for a data prep recipe, a data sync, or a dataflow in the Tableau CRM Data Manager UI.

updateDataflowJob uses this CRM Analytics API resource.

  • dataflowjobId— (Required) The dataflow job ID.

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

    • start
    • stop

    Must be stop to update a dataflow job.

  • A Promise object that resolves with the Dataflow Job response.

There are several ways to use updateDataflowJob. For example, you can display a list of dataflow jobs and enable stop on each queued or running recipe on the list.

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

This button calls the updateDataflowJob() method.