POST/automations/{automation_id}/stop

Stop an automation

Stops an automation by its identifier. Use this operation when you want the automation to stop running; the response includes its status after stopping.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
automation_idstringrequired
The UUID of the automation to stop.

1 status code
200Returns the stopped automation's identifier and its status after the stop operation.
objectstringoptional
Type of the response object.
idstringoptional
The ID of the stopped automation.
statusstringoptional
The status of the automation after stopping.

Error handling

The automation_id path parameter must be a UUID and identify an existing automation.