This guide provides a quick-reference breakdown of all OptiPromo actions and indicates where they can be performed: via the API, in the Optimove UI, or both. Use these tables to understand the scope of automation and plan your integration.
Legend:
- ✅: Supported
- ❌: Not Supported
Action | Description | API | UI |
---|
Set Tenant Metadata | Update tenant basic information and settings. | ❌ | ✅ |
Configure amount reward types | Set up monetary reward types (e.g., $5 off, 10% discount). | ❌ | ✅ |
Configure unit reward types | Set up unit-based reward types (e.g., free shipping, bonus points). | ❌ | ✅ |
Configure customer property schema | Define the schema for customer properties. | ❌ | ✅ |
Configure promotion property schema | Define the schema for promotion properties. | ✅ | ✅ |
Configure session property schema | Define the schema for session properties. | ❌ | ✅ |
Configure customer property synchronization | Define which properties should be synced daily for use within OptiPromo. | ❌ | ✅ |
Action | Description | API | UI |
---|
Create promotion | Create a new promotional campaign. | ✅ | ✅ |
Duplicate promotion | Copy an existing promotion to create a new one. | ✅ | ✅ |
Set promotion metadata | Update a promotion's name, description, and basic info. | ✅ | ✅ |
Set promotion properties | Configure promotion rules and conditions. | ✅ | ✅ |
Set promotion tiers | Configure a multi-tier reward structure. | ✅ | ✅ |
Set reward constraints | Set limits on rewards (max per customer, time limits). | ✅ | ✅ |
Set publishing budgets | Configure spending limits and budget controls. | ✅ | ✅ |
Activate promotion | Launch or start a promotion. | ✅ | ✅ |
Deactivate promotion | Stop or pause a promotion. | ✅ | ✅ |
Archive promotion | Move a promotion to an archived state. | ✅ | ✅ |
Action | Description | API | UI |
---|
Create promocode | Create a new promocode. | ✅ | ✅ |
Set promocode type | Change a promocode's type (e.g., single-use, bulk). | ✅ | ❌ |
Upload promocodes | Bulk upload promocode values from a file. | ✅ | ❌ |
Assign promotion to code | Link a promotion to a promocode. | ✅ | ✅ |
Unassign promotion from code | Remove the promotion link from a promocode. | ✅ | ✅ |
Link campaign | Connect a promocode to a marketing campaign. | ✅ | ❌ |
Unlink campaign | Disconnect a promocode from a campaign. | ✅ | ❌ |
Show promocode | Make a promocode active or visible. | ✅ | ❌ |
Hide promocode | Make a promocode inactive or hidden. | ✅ | ❌ |
Action | Description | API | UI |
---|
Validate Customers | Check if customers are eligible for a promocode. | ✅ | ❌ |