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 at Optimove
    • 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 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
  • 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

OptiMobile & OptiWeb API

  • internal
  • 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

OptiText API

  • Unsubscribes
    • Add Unsubscribespost
    • Get Unsubscribesget
    • Delete Unsubscribesdel

Preference Center

  • Get Preferencesget
  • Update Preferencesput

Gamify

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

Promotions

  • Tenant Query
    • Get tenant data by idget
  • Tenant Command
    • Add or change the promotion property schemaspatch
    • Set Default Unit Reward Type for Promotionspatch
    • Set Default Amount Reward Type for Promotionspatch
  • Promotion Query
    • Get a promotion by idget
    • Validate promotion customerspost
  • Promotion Command
    • Create a promotionpost
    • Archive an existing promotiondel
    • Activate a draft or deactivated 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
    • Set the publishing budgets for a promotionpatch
    • Set the reward constraints for a promotionpatch
    • Create a promotion transactionpost
  • Promocode Query
    • Customers assignment for a list of customers and promocodespost
    • Get a signed upload URL for promocode filesget
    • Get a promocode by idget
    • Validates the given customers for a Promocodepost
  • 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

Sports Inventory REST API

  • /records
    • putput
    • postpost
    • deletedel

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


/HealthCheck/HealthCheck
Triggered Conditional Execution Approval
Did this page help you?

Updated 9 months ago


/HealthCheck/HealthCheck
Triggered Conditional Execution Approval
Did this page help you?