automations

Stop an automation: no new runs start.

Runs already in progress finish as they started, as Resend documents; cancel_runs=true cancels them as well.

post/automations/{id}/stop

Request

  • Base URL: https://api.agentisend.com
  • URL: https://api.agentisend.com/automations/{id}/stop
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

cancel_runs'true' | 'false'

true also cancels the runs in progress: a waiting step is skipped and nothing after it runs.

Headers

Idempotency-Keystring

Makes this call safe to retry. Send the same key with the same body and the original response is replayed instead of the work happening twice. Keys are 1-256 characters and are remembered for 7 days. While the first attempt is still running, a second call with that key returns 409 idempotency_in_flight (Resend calls this concurrent_idempotent_requests); the same key with a different body returns 409 idempotency_payload_mismatch (Resend: invalid_idempotent_request). Resend-Idempotency-Key is accepted as the same header.

Resend-Idempotency-Keystring

Alias of Idempotency-Key. Idempotency-Key wins if both are sent.

Response

Success

object'automation' required
idstring uuid required
status'disabled' required
runs_cancelledinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.