Stop an automation with a tag

What you can do with Stop an automation with a tag

# Set an exit rule

1. Open the trigger

   Open the automation in the flow editor and click the Trigger card at the top of the flow.

   

2. Add the exit tags

   In the side panel, find Exit rule (1). Type a tag, for example JOINED, and press Enter. Add more tags the same way. A contact leaves when they get any of them.

   Click Save (2).

   

3. Check the trigger card

   The trigger card now shows Exits on: with your tags, so you can see the rule without opening the panel.

   

# Send the tag from your website

1. Add the tag with the API

   This is the usual request for adding a tag to a contact. Replace SUBSCRIBER_ID with the contact's id and YOUR_API_TOKEN with your token:

   curl -X POST 'https://<your app address>/api/v1/subscribers/SUBSCRIBER_ID/add-tag' \
     -H 'Accept: application/json' \
     -d api_token=YOUR_API_TOKEN \
     -d tag=JOINED
   

   As soon as this request succeeds, the contact leaves every automation whose exit rule names JOINED.

# Branch on a tag with a Condition

1. Check a tag in a Condition

   Add a Condition step, or open one. Under The contact… choose Has a tag or Doesn't have a tag, and type the tag in Tag (1).

   Contacts who match go down the yes path; everyone else goes down no.

   If the condition only checks tags, empty the number under Wait this long before deciding (2). The contact is then checked the moment they reach the step. With a wait set, the check happens at the end of it.

   

# See who left the automation

1. Look at the Exited count

   Open the automation and click Statistics. The breakdown at the top has a Triggered: exited row: the contacts who left before the end.

   

2. List the contacts who left

   In the contacts table, choose Exited in the status filter (1). Each of these contacts has the Exited status (2).

   

3. See why a contact left

   Click Progress on a row. The history shows when the contact left and why:

   • Exited · got the tag JOINED — the exit rule removed them.
   • Exited · removed by hand — someone used Remove from automation.
   • Exited · removed via the API — your software removed them.

   

# Remove one contact by hand

1. Open the row menu

   In Statistics, find the contact in the contacts table (the Waiting filter helps). Click ⋯ at the end of the row and choose Remove from automation. The action is there only while the contact is still in the flow.

   

2. Confirm

   Click Remove from automation to confirm. The contact's status changes to Exited and they get no more emails from this automation.

   

# Remove a contact with the API

1. Find the automation's uid

   Each automation has a uid. List your automations to find it:

   curl -X GET 'https://<your app address>/api/v1/automations' \
     -H 'Accept: application/json' \
     -H 'Authorization: Bearer YOUR_API_TOKEN'
   

   The answer lists every automation with its uid and name.

2. Send the exit request

   Send the contact's email address to the automation's exit address:

   curl -X POST 'https://<your app address>/api/v1/automations/AUTOMATION_UID/exit' \
     -H 'Accept: application/json' \
     -H 'Authorization: Bearer YOUR_API_TOKEN' \
     -d email=jane@example.com
   

   Instead of email, you can send subscriber_uid or subscriber_id.

   The answer tells you what happened:

   {"success": true, "exited": 1, "message": "Subscriber removed from the automation"}
   

   Answer	Meaning
   exited: 1 or more	The contact was removed.
   exited: 0	The contact had no active run: they never entered, already finished, or were already removed.
   Status 404	The automation uid is wrong, or no contact with that address is in the automation's lists.
   Status 422	The request had no email, subscriber_uid or subscriber_id.

Common questions

Related guides