Revising campaigns
Revise an active campaign to make independently tested changes to its rules and settings without affecting the current rules and settings. You can revise Running, Scheduled, and Expired campaigns.
You can revise a campaign only if campaign staging and revisions is enabled for your Application.
Campaign revision summary
The campaign revision process allows you to make changes to an active campaign without affecting its current rules and settings.
By revising an active campaign, you independently modify its rules and settings, test your changes to those rules, and apply them to the active campaign at a time you choose.
The coupons, referrals, and achievements you create and manage are not affected by revisions.
Campaign revision process
The campaign revision process contains the following steps:
- Creating the revision.
-
In this step, you create a copy of the active campaign with all the current rules and settings, called the revision.
You can make your changes to the rules and settings of the revision.
-
This step does not affect the active campaign.
-
- Testing the revision.
- In this step, you test your changes to the rules in the revision in the same way you test a Staged campaign.
- This step does not affect the active campaign.
- Finalizing the revision.
- In this step, you apply your changes from the revision to the active campaign immediately or set a schedule to apply them in the future. To make further changes, revise the campaign again.
Creating the revision
The revision is a copy of the active campaign whose rules and settings you can modify without affecting the current rules and settings of the active campaign.
To create the revision:
- Open a Running, Scheduled, or Expired campaign.
- In the State section of the campaign dashboard, click Create Revision.
Your active campaign now has a second state called Revised, indicating that your campaign has an ongoing revision. You can make any desired changes to the rules or campaign settings of the revision.
At any point, from the top of the page, switch between:
- The active campaign: The campaign rules and settings can only be viewed.
- The revision: The campaign rules and settings can be modified.
Testing the revision
You can test your changes to the rules in the revision in the same way you test Staged campaigns. The triggered effects are not retained and do not affect the active campaign. See Testing a campaign.
To trigger the effects of a Revised campaign, use a testing API key. If you're unsure of which key your testing environment uses, contact your development team.
Finalizing the revision
By finalizing the revision, you apply its changes to the active campaign. You can choose to finalize the revision immediately or schedule it for a future time.
To finalize the revision:
-
Open a Running, Scheduled, or Expired campaign.
-
From the top of the page, switch to the revision .
-
In the State section of the campaign dashboard, click Finalize Revision.
-
In the pop-up that appears, select when to apply the changes from the revision to the active campaign:
-
Finalize revision immediately: Applies the changes immediately.
-
Schedule finalization: Applies the changes at the selected future time.
noteThe time you select cannot fall before the campaign start date.
-
-
Click Confirm.
When the finalization occurs, the changes from your revision are applied to the active campaign and the revision no longer appears. To make further changes, revise the campaign again.
If you schedule the finalization for a future time, the campaign state changes from Revised to Pending. In this state, the revision can still be modified.
Finalizing the revision in multiple campaigns
You can finalize the revision in up to 50 Revised campaigns in a single operation.
To finalize the revision in multiple campaigns:
-
On the Campaigns page, click the Revised filter. See Filtering campaigns.
-
Select one or more filtered campaigns, and click Finalize.
-
In the pop-up that appears, select when to apply the changes from the revision to the active campaign:
-
Finalize revision immediately: Applies the changes immediately.
-
Schedule finalization: Applies the changes at the selected future time.
noteThe time you select cannot fall before the campaign start date.
-
-
Click Confirm.
Canceling the finalization
If you decide to cancel applying your changes from the revision, you can cancel the finalization.
To cancel the finalization:
- Open a Pending campaign.
- From the top of the page, switch to the revision .
- In the State section of the campaign dashboard, click Cancel Finalization.
The campaign state returns to Revised.
Deleting the revision
You can discard your changes entirely by deleting the revision. When you delete the revision, the active campaign stays unchanged and unaffected.
To delete the revision:
- Open a Revised campaign.
- From the top of the page, switch to the revision .
- In the State section of the campaign dashboard, click > Delete Revision.
The revision is deleted without any further confirmation.