For AI agents: visit https://developer.optimove.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Optimove Developers Hub
HomeGuidesAPI ReferenceChange log
Optimove Developers Hub
API Reference
HomeGuidesAPI ReferenceChange log

Optimove API

  • Getting Started with Optimove API
    • Optimove API Overview
    • Glossary
    • General Information
    • Generating API Keys
    • Authentication Guide
    • Roles & Permissions
    • Understanding API Rate Limits
    • IP Allow List
    • Error Handling
  • General
    • Last Data Updateget
    • Register Event Listenerpost
    • Unregister Event Listenerpost
    • Registered Event Listenersget
  • Api Key
    • Api Key Infoget
  • Model
    • Customer Attribute Listget
    • Lifecycle Stage Listget
    • Microsegment Listget
    • MicroSegment Changersget
  • Actions
    • All Actionsget
    • Actions By Target Groupget
    • Action IDget
    • Action Nameget
    • Action Details By Target Groupget
    • Promo Codesget
    • Promo Codes By Campaignget
    • Promo Codes By Target Groupget
    • Executed Campaign Detailsget
    • Campaign Detailsget
    • Execution Channelsget
    • Executed Campaigns By Channelget
    • Executed Campaign Channel Detailsget
  • Target Groups
    • Target Groups By Dateget
    • Target Group IDget
    • Target Group Nameget
    • Target Group Detailsget
  • Customers
    • Currently Targeted Customersget
    • Insert Or Update Customersput
    • Insert Or Update Customerput
    • Canceled Campaign Customersget
    • Processed Campaign Customersget
    • Customer Last Action Executedget
    • Customer Actions By Target Groupget
    • Customer One Time Actions By Campaignget
    • Customer One Time Actions By Dateget
    • Customers By Actionget
    • Customers Action Ended By Dateget
    • Customer Send Details By Campaignget
    • Customer Send Details By Channelget
    • Customer Execution Details By Campaignget
    • Customer Action Details By Dateget
    • Customer Product Details By Dateget
    • Customer Product Details By Campaignget
    • Customer Product Recommendationsget
    • Customer Future Valuesget
    • Customers Activity Event Attributesget
    • Campaign Interaction Customersget
    • Customer Channel Interactionsget
    • Customer Attributesget
    • Campaign Engagement Metricsget
    • Add Customer Attributepost
    • Update Customer Attributespost
    • Customer Attribute Changersget
    • Remove Customer PIIpost
  • Value Segment
    • Value Segmentsget
    • Value Segment IDget
    • Value Segment Nameget
    • Customers By Value Segmentget
    • Value Segment Changersget
  • External System Integration
    • Channel Templatesget
    • Channel Template Detailsget
    • Add Channel Templatespost
    • Delete Channel Templatespost
    • Add Channel Appspost
    • Delete Channel Appspost
    • Promotionsget
    • Add Promotionspost
    • Delete Promotionspost
    • Activity Event Listget
    • Update Campaign Metricspost
    • Update Campaign Interactionspost
    • Update Customer Promotion Statuspost
    • Set Customer Channel Preferencepost
  • Optimail
    • Template Foldersget
    • Email Parametersget
    • Add Templatepost
    • Update Templatepost
    • Unsubscribersget
    • Add Unsubscriberspost
    • Delete Unsubscriberspost
  • Transactional Mail
    • Send Transactional Mailpost
    • Send Finalized Transactional Mailpost
    • Template Detailsget
    • Transactional Template Metricsget
    • Transactional User Metricsget
  • HealthCheck
    • /HealthCheck/HealthCheckget
  • Customer Lists
    • Creates a new customer list.post
    • Updates a target group with a new customer list.put
    • Gets a customer list by ID.get
    • Creates a new target group with existing target group condition.post
    • Updates a target group with existing target group condition.put
    • Adds customers to an existing customer list.post
    • Reload customers in a customer list.put
    • Gets metadata for all customer lists.get
  • Triggered Conditional Execution
  • Triggered Conditional Execution Approval
    • Create conditional execution approval.post
  • Triggered Conditional Execution Settings
    • Conditional execution settingsget
    • Create conditional execution settingspost
    • Update conditional execution settingspatch
  • Triggered Conditional Execution Webhooks
    • Conditional execution webhooksget
    • Create conditional execution webhookpost
    • Conditional execution webhookget
    • Delete conditional execution webhookdel
  • Triggers
    • Register Event Listenerpost
    • Unregister Event Listenerpost
  • target-group
    • Removes customers from an existing customer list.del

OptiMobile & OptiWeb API

  • Overview
  • OptiMobile SDK Reference
  • No-SDK Integration
    • Add Devicepost
    • Receiving Push Notifications
    • Tracking Openspost
    • Remove Devicedel
  • Transactional Messaging
    • Send Pushpost
    • Cancel Scheduled Pushdel
    • Send In-App Messagepost
  • Testing and Troubleshooting

Optimobile Web Inbox API

  • Overview
    • Get Embedded Messages
    • Report Message Events
  • EmbeddedMessage
    • Get Embedded Messaging user messages for a specific container using POSTpost
  • Message
    • Get Web Inbox user messagesget
    • Update Web Inbox message read statusput
    • Report Web Inbox Message metricspost
    • Delete Web Inbox messagedel

SMS API

  • Unsubscribes
    • Add Unsubscribes (V1)post
    • Delete Unsubscribes (V1)del
    • Get Unsubscribesget
    • Add Unsubscribes (V2)post
    • Delete Unsubscribes (V2)del

Preference Center

  • Get Preferencesget
  • Update Preferencesput
  • Get Smart Campaign Preferencesget
  • Update Smart Campaign Preferencesput
  • Topics
    • Get topicsget
    • Create topicpost
    • Update topicput
    • Delete topicdel

Gamify

  • Register Playerpost
  • Prize Codespost
  • Assigned Prizesget
  • Leaderboardget
  • Segmentsget

Loyalty System

  • Welcome to the Loyalty System
  • Brand
    • Default Brand for Tenantget
  • Theme
    • Widget Themeget
  • Player Profile
    • Player Profileget
    • Update Player Display Nameput
  • Levels
    • Player Level and XP Progressget
    • All Level Tiers for a Playerget
    • Claim a Level Rewardpost
  • Missions
    • Player Missionsget
    • Single Mission by Objectiveget
    • Unlock a Mission (Spend Currency)patch
    • Claim a Mission Rewardpost
    • Calculated-Reward Missions for a Playerget
  • Rewards
    • Brand Rewards Catalogget
  • Player Rewards
    • Player Reward Balancesget
    • Player Badgesget
  • Leaderboards
    • List Leaderboards for a Brandget
    • Player Enrollment and Score on a Leaderboardget
    • Tournament Enrollment Statusget
    • Enroll a Player in a Tournamentpost
  • Leaderboard Statistics
    • Player's Current Rankget
    • Top Players on a Leaderboardget
    • Players in a Rank Rangeget

Promotions

  • Tenant Query
    • Get tenant data by idget
  • Tenant Command
    • Add or change the promotion property schemaspatch
    • Set Default Amount Reward Type for Promotionspatch
    • Set Default Unit Reward Type for Promotionspatch
  • Promotion Query
    • Get list of promotionsget
    • Get a promotion by idget
  • Promotion Command
    • Create a promotionpost
    • Archive an existing promotiondel
    • Activate a draft or deactivated promotionpatch
    • Set the reward constraints for a promotionpatch
    • Set the publishing budgets for a promotionpatch
    • Refresh budgets status for a promotionpatch
    • Deactivate an active promotionpatch
    • Duplicate an existing promotionpost
    • Set metadata in promotionpatch
    • Set the list of promotion tiers in a promotionpatch
    • Set promotion propertiespatch
    • Create a promotion transactionpost
  • Promocode Command
    • Create a promocodepost
    • Load codes filepatch
    • Set the configuration of a personalized promocodepatch
    • Hide promocode from listpatch
    • Link a promocode to campaignpatch
    • Reassign the promocode to another promotionpatch
    • Show promocode in listpatch
    • Create a promocode transactionpost
    • Unlink a promocode from campaignpatch
  • PromoCode Query
    • Customers Assignmentpost
    • Get upload URL for code filesget
    • Get a promocode by idget
    • Report Customer Redemptionspost
    • Customer Validationpost
  • Publisher Command
    • Publish a triggered campaign for real-time customer validationpost
    • Register webhooks for conditional campaign executionpost
    • Start a conditional execution campaignpost

Sports Inventory REST API

  • /records
    • /recordsput
    • /recordspost
    • /recordsdel

Data Connections

  • Management
    • List Data Connectionsget
    • Create Data Connectionpost
    • Get Data Connectionget
    • Update Data Connectionput
    • Delete Data Connectiondel
  • References
    • Get Data Connection Referencesget
    • Add Data Connection Referencepost
    • Delete Reference From Data Connectiondel
  • Data Management
    • Upload Data To Data Connectionpost
    • Update Data In Data Connectionput
    • Delete Data From Data Connectionpost
    • Clear Data From Data Connectionpost
  • 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 9 months ago


Gets metadata for all customer lists.
Triggered Conditional Execution Approval
Did this page help you?

Updated 9 months ago


Gets metadata for all customer lists.
Triggered Conditional Execution Approval
Did this page help you?