DELETE https://api.usecommune.com/automations/{automation} Production. There is no separate sandbox host.

Archive an automation

Takes an automation out of service. Needs sending: write, and is a write.

It archives rather than erases, and the distinction is what you keep. The runs underneath an automation are the record of what was emailed to whom. Erasing them would mean tidying up a draft you had abandoned also destroyed the sending history of the sequence that ran last month, with nothing to say so. So status becomes archived, which is not active, so it sends nothing, and the automation and its runs stay readable.

The runs it was in the middle of are ended, with an exit_reason saying so. That is the difference from pausing: a pause is coming back and holds every run on its step, and an archive is not, so a run holding its place would be a subscriber stuck part way through forever.

Archiving an archived automation succeeds and changes nothing. There is no way back: write a new automation instead.

Publishes no event.

Path parameters

  • string(uuid) Required

Request Headers

  • string Required
  • string
DELETE /automations/{automation}
Loading...

Share your request

Use this link to easily share a pre-filled request of this operation. Everything you filled will be shared apart from the authentication fields.

Request URL

https://api-reference.usecommune.dev/explorer/operation/operation-deleteautomation

Send a delete request

It looks like you’re about to send a DELETE request to this API. This type of request carries a risk of permanent and irreversible data loss.

Are you sure you want to continue?
Response
Waiting for a request to be sent.