Stop an Instance

Stops a running Instance of a Workflow.


Permissions Required

Find and Edit permissions are required for an Instance in order to stop it. The Instance Owner has implicit Find and Edit permissions, and can always stop Instances they own.

Method Signature

stop(string $id): Instance


$idstringThe id of the Instance to stop
returnsInstanceThe stopped Instance



 * This example demonstrates stopping an Instance by ID

require_once(__DIR__ . '/vendor/autoload.php');

use \Catalytic\SDK\CatalyticClient;

$catalytic = new CatalyticClient();
$instance = $catalytic->instances()->stop('c9f2beec-10c0-4f2f-b4e0-1d884c7e053c');