/
OP
optimove
/
Optimove API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 1mo ago · Updated 1mo ago
Details
Filter operations
Actions
13
get
All Actions
get
Actions By Target Group
get
Action ID
get
Action Name
get
Action Details By Target Group
get
Promo Codes
get
Promo Codes By Campaign
get
Promo Codes By Target Group
get
Executed Campaign Details
get
Campaign Details
get
Execution Channels
get
Executed Campaigns By Channel
get
Executed Campaign Channel Details
Api Key
1
get
Api Key Info
Batch Query
1
post
Api Batch Query Data Connection Data
Brand
1
get
Default Brand for Tenant
Customers
28
get
Currently Targeted Customers
put
Insert Or Update Customers
put
Insert Or Update Customer
get
Canceled Campaign Customers
get
Processed Campaign Customers
get
Customer Last Action Executed
get
Customer Actions By Target Group
get
Customer One Time Actions By Campaign
get
Customer One Time Actions By Date
get
Customers By Action
get
Customers Action Ended By Date
get
Customer Send Details By Campaign
get
Customer Send Details By Channel
get
Customer Execution Details By Campaign
get
Customer Action Details By Date
get
Customer Product Details By Date
get
Customer Product Details By Campaign
get
Customer Product Recommendations
get
Customer Future Values
get
Customers Activity Event Attributes
get
Campaign Interaction Customers
get
Customer Channel Interactions
get
Customer Attributes
get
Campaign Engagement Metrics
post
Add Customer Attribute
post
Update Customer Attributes
get
Customer Attribute Changers
post
Remove Customer PII
Data Management
4
post
Upload Data To Data Connection
put
Update Data In Data Connection
post
Delete Data From Data Connection
post
Clear Data From Data Connection
EmbeddedMessage
1
post
Get Embedded Messaging user messages for a specific container using POST
External Content
1
post
Emarsys External Content Lookup
External System Integration
14
get
Channel Templates
get
Channel Template Details
post
Add Channel Templates
post
Delete Channel Templates
post
Add Channel Apps
post
Delete Channel Apps
get
Promotions
post
Add Promotions
post
Delete Promotions
get
Activity Event List
post
Update Campaign Metrics
post
Update Campaign Interactions
post
Update Customer Promotion Status
post
Set Customer Channel Preference
General
4
get
Last Data Update
post
Register Event Listener
post
Unregister Event Listener
get
Registered Event Listeners
HealthCheck
1
get
/HealthCheck/HealthCheck
internal
1
patch
Refresh budgets status for a promotion
Leaderboard Statistics
3
get
Player's Current Rank
get
Top Players on a Leaderboard
get
Players in a Rank Range
Leaderboards
4
get
List Leaderboards for a Brand
get
Player Enrollment and Score on a Leaderboard
get
Tournament Enrollment Status
post
Enroll a Player in a Tournament
Levels
3
get
Player Level and XP Progress
get
All Level Tiers for a Player
post
Claim a Level Reward
Management
5
get
List Data Connections
post
Create Data Connection
get
Get Data Connection
put
Update Data Connection
delete
Delete Data Connection
Message
4
get
Get Web Inbox user messages
put
Update Web Inbox message read status
post
Report Web Inbox Message metrics
delete
Delete Web Inbox message
Missions
5
get
Player Missions
get
Single Mission by Objective
patch
Unlock a Mission (Spend Currency)
post
Claim a Mission Reward
get
Calculated-Reward Missions for a Player
Model
4
get
Customer Attribute List
get
Lifecycle Stage List
get
Microsegment List
get
MicroSegment Changers
Optimail
7
get
Template Folders
get
Email Parameters
post
Add Template
post
Update Template
get
Unsubscribers
post
Add Unsubscribers
post
Delete Unsubscribers
Player Profile
2
get
Player Profile
put
Update Player Display Name
Player Rewards
2
get
Player Reward Balances
get
Player Badges
preview
2
patch
Set the reward constraints for a promotion
patch
Set the publishing budgets for a promotion
PromoCodeCommand
9
post
Create a promocode
patch
Load codes file
patch
Set the configuration of a personalized promocode
patch
Hide promocode from list
patch
Link a promocode to campaign
patch
Reassign the promocode to another promotion
patch
Show promocode in list
post
Create a promocode transaction
patch
Unlink a promocode from campaign
PromoCodeQuery
5
post
Customers Assignment
get
Get upload URL for code files
get
Get a promocode by id
post
Report Customer Redemptions
post
Customer Validation
PromotionCommand
9
post
Create a promotion
delete
Archive an existing promotion
patch
Activate a draft or deactivated promotion
patch
Deactivate an active promotion
post
Duplicate an existing promotion
patch
Set metadata in promotion
patch
Set the list of promotion tiers in a promotion
patch
Set promotion properties
post
Create a promotion transaction
PromotionQuery
2
get
Get list of promotions
get
Get a promotion by id
PublisherCommand
3
post
Publish a triggered campaign for real-time customer validation
post
Register webhooks for conditional campaign execution
post
Start a conditional execution campaign
Query
1
post
Query Data Connection Data
References
3
get
Get Data Connection References
post
Add Data Connection Reference
delete
Delete Reference From Data Connection
Rewards
1
get
Brand Rewards Catalog
Schema
1
get
Get Data Connection Schema
SMS Unsubscribes
2
post
Add Unsubscribes (V2)
delete
Delete Unsubscribes (V2)
Target Groups
4
get
Target Groups By Date
get
Target Group ID
get
Target Group Name
get
Target Group Details
target-group
9
put
Updates a target group with a new customer list.
post
Creates a new customer list.
get
Gets a customer list by ID.
put
Updates a target group with existing target group condition.
post
Creates a new target group with existing target group condition.
put
Reload customers in a customer list.
post
Adds customers to an existing customer list.
get
Gets metadata for all customer lists.
delete
Removes customers from an existing customer list.
TenantCommand
3
patch
Add or change the promotion property schemas
patch
Set the amount reward type default for all tenant promotions
patch
Set the unit reward type default for all tenant promotions
TenantQuery
1
get
Get a tenant by id
Theme
1
get
Widget Theme
Topics
4
get
Get topics
put
Update topic
post
Create topic
delete
Delete topic
Transactional Mail
5
post
Send Transactional Mail
post
Send Finalized Transactional Mail
get
Template Details
get
Transactional Template Metrics
get
Transactional User Metrics
Triggered Conditional Execution Approval
1
post
Create conditional execution approval.
Triggered Conditional Execution Settings
3
get
Conditional execution settings
post
Create conditional execution settings
patch
Update conditional execution settings
Triggered Conditional Execution Webhooks
4
get
Conditional execution webhooks
post
Create conditional execution webhook
get
Conditional execution webhook
delete
Delete conditional execution webhook
Triggers
2
post
Register Event Listener
post
Unregister Event Listener
Value Segment
5
get
Value Segments
get
Value Segment ID
get
Value Segment Name
get
Customers By Value Segment
get
Value Segment Changers
post
Add Device
delete
Remove Device
post
Tracking Opens
post
Send Push
delete
Cancel Scheduled Push
post
Send In-App Message
get
Get Unsubscribes
post
Add Unsubscribes (V1)
delete
Delete Unsubscribes (V1)
get
Get Preferences
put
Update Preferences
get
Get Smart Campaign Preferences
put
Update Smart Campaign Preferences
post
Register Player
post
Prize Codes
get
Assigned Prizes
get
Leaderboard
get
Segments
put
/records
post
/records
delete
/records
General
Last Data Update
Returns the date of the most recently available customer data.
get
/General/GetLastDataUpdate
Response
Success
OptimoveAPIModelsOptimoveLastDataUpdate
required
Date
string
nullable
Changes