|
| 1 | +--- |
| 2 | +title: Journeys Edits & Versioning |
| 3 | +plan: engage-foundations |
| 4 | +hidden: true |
| 5 | +--- |
| 6 | + |
| 7 | +With Journeys edits and versioning, you can make changes to live journeys. |
| 8 | + |
| 9 | +## Before you begin |
| 10 | + |
| 11 | +Keep the following in mind when you edit a journey: |
| 12 | + |
| 13 | +- To create a new journey version, you can edit the current, live version or restore a previous version. |
| 14 | +- You can only have one live journey version at any time. When you publish a draft journey version, Segment prompts you to pause or archive the previous version of the journey (if it isn’t archived already). If you pause the previous version, it begins to drain any users left in the version while you paused it. |
| 15 | +- If the previous version is in a paused, draining state, users can continue flowing through it until you archive it, or if users successfully exit that version through its exit settings. |
| 16 | +- If you enable version exclusion when you edit a live journey, users in previous versions of the journey won't enter the latest version. |
| 17 | +- Segment preserves destination sync keys in the Segment backend for destination steps that remain the same between versions. You don't need to update these keys in your downstream destinations when creating a new journey version that has the same destination step as a previous version. In the destination step UI, however, the destination sync key will be different between versions. |
| 18 | +- You can create up to 25 versions of a journey. Segment keeps previous journey versions in a journey container, which you can access from the Journeys list page. |
| 19 | + |
| 20 | +## Edit a journey |
| 21 | + |
| 22 | +Follow these steps to edit a journey: |
| 23 | + |
| 24 | +1. From your Engage space, click the **Journeys** tab. |
| 25 | +2. From the Journeys list page, select the journey version you want to edit. |
| 26 | +3. On the Journey overview page, select **Edit**. Segment creates a new version in draft mode. |
| 27 | +4. Edit your Journey, then select **Publish version**. |
| 28 | + - If the previous version is live, Segment asks whether you want to pause or archive the previous version. |
| 29 | + - If you pause the previous version, users can continue through the journey version, but no new users can enter. You will not be able to resume this journey version if it is paused this way. |
| 30 | + - If you archive the previous version, users **won't** continue through the journey version. |
| 31 | +5. (Optional:) Enable version exclusion. |
| 32 | +6. Click **Publish**. |
| 33 | + |
| 34 | +After you’ve published, users who meet the entry criteria can enter the new journey version. |
| 35 | + |
| 36 | +You can return to the Journeys list page to view the new live journey and its previous versions, which are nested under the journey container. |
| 37 | + |
| 38 | +## Working with Journeys versioning |
| 39 | + |
| 40 | +### Exit settings and user flow between journeys |
| 41 | + |
| 42 | +Exit settings determine how users flow between journey versions. |
| 43 | + |
| 44 | +Suppose you have a journey with exit settings enabled. The following table lists the actions you can take with the journey, as well as the results: |
| 45 | + |
| 46 | +| Action | Result | |
| 47 | +| --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
| 48 | +| Pause Version 1 and publish Version 2 | Users will flow through Version 1 until they meet its exit settings. <br><br> Once users exit Version 1, they can enter Version 2 upon meeting its entry criteria. | |
| 49 | +| Archive Version 1 and publish Version 2 | Users can enter Version 2 when they meet its entry criteria. | |
| 50 | +| Pause Version 1, publish Version 2, then archive Version 1 before users have exited Version 1 | Users won’t be able to enter Version 2. Users must successfully exit the paused Version 1 before entering Version 2. <br><br> In this situation, Segment recommends that you wait until users have exited the journey through exit settings before archiving the version. <br><br> Alternatively, instead of pausing and archiving a version, Segment recommends that you archive the previous version when you publish the subsequent version. | |
| 51 | + |
| 52 | +Suppose you have a journey **without** enabled exit settings. If you pause or archive Version 1 when publishing Version 2 of that journey, then users can immediately enter Version 2 when they meet its entry criteria, even if they’re still in Version 1. |
| 53 | + |
| 54 | +> info "Version exclusion" |
| 55 | +> To prevent users from a previous journey from ever entering a new journey version, enable version exclusion when you create the new journey version. |
| 56 | +
|
| 57 | + |
| 58 | +### List destinations |
| 59 | + |
| 60 | +Adding a list destination to a journey version creates a new record in Segment’s systems. This process can take up to ten hours. During this time, you’ll be unable to publish new versions of a journey. |
| 61 | + |
| 62 | +For example, if you add a list destination to Version 1 of a journey, and users begin flowing into the version, then Segment will begin creating the new record. If you create a Version 2 draft from Version 1 of the journey while Segment is still creating the new record, you won’t be able to publish Version 2 until this process is completed. |
| 63 | + |
| 64 | +If the version has a list destination but no users have flowed into the version, though, Segment won't create a new record for that list destination and you won't have to wait to publish a new journey version. |
0 commit comments