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
Optimail
Transactional Mail
HealthCheck
- /HealthCheck/HealthCheckget
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

OptiMobile & OptiWeb API

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

Optimobile Web Inbox API

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

OptiText API

Unsubscribes

Preference Center

Get Preferencesget
Update Preferencesput

Promotions

TenantQuery
- Get a tenant by idget
- Get a signed upload URL (e.g., image for Reward Type)get
Tenant Command
Promotion Query
- Get a promotion by idget
- Validate promotion customerspost
PromotionCommand
PromoCode Query
- Get a promocode by idget
- Validates the given customers for a Promocodepost
PromoCode Command

Sports Inventory REST API

/records

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

Set metadata in promotion

patch https://optipromo-promotions-eu.optimove.net/v1/promotions/{promotionId}/metadata

Language

Credentials

Header

Click Try It! to start a request and see the response here!