1. Create tenant properties and get definitions

Set Tenant Promotion Properties- set up the promotion properties that will be available for configuration in promotions.
Get Tenant Config Details – get existing configuration details of properties. You can also get the list of customer properties (customer attributes)

2. Create, edit and get promotions
Create Promotion – Create name, code, description. Promotion will be created as a draft. (can be done via UI)
Delete Promotion – Promotion will become archived, it will be removed from Campaign Builder dropdown, running campaigns that use it- it will not be validated and cannot restored (only duplicated). (can be done via UI)
Promotion Activation – Activate a promotion to make it avaliable for campaigns in campaign builder. (can be done via UI)
Promotion Deactivation – Promotion will be deactivate. it will be removed from Campaign Builder dropdown, running campaigns that use it- it will not be validated and can be activated again. (can be done via UI)
Duplicate Promotion – Duplicate a promotion with same details and a new code. (can be done via UI)
Edit Promotion Metadata – Edit promotion name and description (when draft, deactivated and active)
Set Promotion Reward Tiers – Set calculation for promotion reward tiers. (can be done via UI)
Set Promotion Properties – set properties to promotion (from existing tenant promotion list). (can be done via the UI)

Note that when the promotion is in Deactivated status you will be able to edit properties as well. Tiers cannot be edited at any point after promotion is Active, even if Deactivated.
Note that under Promotions Command, you are also able to send multiple number of commands in one API call.

Add promotion to campaigns

Add promotion to campaign in campaign builder via the UI and scheduling the campaign

Get promotion and promotion value

Listener Notified that a New Campaign is Ready
Retrieve the campaign details using the GetCampaignDetails API call with the Campaign ID that was supplied to the listener, and extract the details for the campaign:
Retrieve the promo code, Action IDs, and the list of Customer IDs for the Campaign ID using the GetCustomerExecutionDetailsByCampaign API call.
Retrieve additional promotion details (optional) – get all promotion details: properties, tier calculation, etc.
Retrieve promotion reward value per customer by customer ID - will be done by batch of customer IDs.
• Full process on promotion system integration into Optimove is described here

OptiPromo Process

All Relevant API calls