API vs. UI Functionality

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

Tenant Management

ActionDescriptionAPIUI
Set Tenant MetadataUpdate tenant basic information and settings.✅❌
Configure amount reward typesSet up monetary reward types (e.g., $5 off, 10% discount).✅✅
Configure unit reward typesSet up unit-based reward types (e.g., free shipping, bonus points).✅✅
Configure customer property schemaDefine the schema for customer properties.✅❌
Configure promotion property schemaDefine the schema for promotion properties.✅✅
Configure session property schemaDefine the schema for session properties.✅❌
Configure customer property synchronizationDefine which properties should be synced daily for use within OptiPromo.✅✅

Promotion Management

ActionDescriptionAPIUI
Create promotionCreate a new promotional campaign.✅✅
Duplicate promotionCopy an existing promotion to create a new one.✅✅
Set promotion metadataUpdate a promotion's name, description, and basic info.✅✅
Set promotion propertiesConfigure promotion rules and conditions.✅✅
Set promotion tiersConfigure a multi-tier reward structure.✅✅
Set reward constraintsSet limits on rewards (max per customer, time limits).✅✅
Set publishing budgetsConfigure spending limits and budget controls.✅✅
Activate promotionLaunch or start a promotion.✅✅
Deactivate promotionStop or pause a promotion.✅✅
Archive promotionMove a promotion to an archived state.✅✅

Promocode Management

ActionDescriptionAPIUI
Create promocodeCreate a new promocode.✅✅
Set promocode typeChange a promocode's type (global / personalized / no-code)✅✅
Upload unique-codesBulk upload promocode values from a file.✅✅
Assign promotion to codeLink a promotion to a promocode.✅✅
Unassign promotion from codeRemove the promotion link from a promocode.✅✅
Link campaignConnect a promocode to a marketing campaign.✅❌
Unlink campaignDisconnect a promocode from a campaign.✅❌
Show promocodeMake a promocode active or visible.✅❌
Hide promocodeMake a promocode inactive or hidden.✅❌

Customer Validation

ActionDescriptionAPIUI
Validate CustomersCheck if customers are eligible for a promocode.✅❌

Did this page help you?