For AI agents: visit https://developer.optimove.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Guides API Reference Change log

API Reference

Home Guides API Reference Change log

Optimove API

Getting Started with Optimove API
General
Api Key
- Api Key Infoget
Model
Actions
Target Groups
Customers
Value Segment
External System Integration
Email
Transactional Mail
HealthCheck
- /HealthCheck/HealthCheckget
Customer Lists
Triggered Conditional Execution
Triggered Conditional Execution Approval
- Create conditional execution approval.post
Triggered Conditional Execution Settings
Triggered Conditional Execution Webhooks
Triggers
- Register Event Listenerpost
- Unregister Event Listenerpost
target-group
- Removes customers from an existing customer list.del

Mobile & Web API

Overview
Mobile SDK Reference
No-SDK Integration
Transactional Messaging
Testing and Troubleshooting

Mobile Web Inbox API

Overview
- Get Embedded Messages
- Report Message Events
EmbeddedMessage
- Get Embedded Messaging user messages for a specific container using POSTpost
Message

SMS API

Unsubscribes

Preference Center

Get Preferencesget
Update Preferencesput
Get Smart Campaign Preferencesget
Update Smart Campaign Preferencesput
Topics

Gamify

Register Playerpost
Prize Codespost
Assigned Prizesget
Leaderboardget
Segmentsget
Set Player Gameplay Limitpost
Campaign Participation Tokenpost

Loyalty System

Welcome to the Loyalty System
Brand
- Default Brand for Tenantget
Theme
- Widget Themeget
Player Profile
- Player Profileget
- Update Player Display Nameput
Levels
Missions
Rewards
- Brand Rewards Catalogget
Player Rewards
- Player Reward Balancesget
- Player Badgesget
Leaderboards
Leaderboard Statistics

Promotions

Tenant Query
- Get a tenant by idget
Tenant Command
Promotion Query
- Get list of promotionsget
- Get a promotion by idget
Promotion Command
Promocode Command
Promocode Query
Publisher Command

Personalize API

Sports Inventory

Data Connections

Management
References
Data Management
Schema
- Get Data Connection Schemaget
Query
- Query Data Connection Datapost
External Content
- Emarsys External Content Lookuppost
Batch Query
- Api Batch Query Data Connection Datapost

Triggered Conditional Execution

Updated 10 months ago

Gets metadata for all customer lists.

Triggered Conditional Execution Approval

Did this page help you?

Updated 10 months ago

Gets metadata for all customer lists.

Triggered Conditional Execution Approval

Did this page help you?