Logo
Sign in
  • User Guide
  • Developer Guide
  • Partner Guide
  • Use Cases
  • Resources
  • Contact Support
  • User Guide
  • Developer Guide
  • Partner Guide
  • Use Cases
  • Resources
  • Contact Support
  • iOS SDK
    • SDK Integration
      • Basic
        • SDK Integration
        • SDK Initialization
        • Data Center
      • Advanced
        • Add-On-Security
    • Data Tracking
      • Basic
        • Install/Update differentiation
        • Tracking user attributes
        • Tracking events
      • Advanced
        • Session and Source Tracking
    • Push
      • Basic
        • Push Notifications
        • APNS Authentication Key
        • APNS Certificate/PEM file
      • Optional
        • Push Notification Implementation
        • Notification Service
        • Push templates
        • Push Handled by Application
        • Actionable Notifications
        • Real-Time Triggers
        • iOS Notification Center
        • Location triggered
      • Advanced
        • Custom Notification Handling
    • In-App Messages
      • In-App Nativ
    • Cards
      • Integration
        • SDK Installation
      • Types of Cards
        • SDK Methods for Cards
        • Card Properties
      • Customise UI
        • Setup View Controller
          • Displaying AppInbox/Feeds
      • API-Triggered Cards
        • Overview
      • Cards in iOS
      • Self Handled Cards
    • Checklist
      • Release Checklist
    • Compliance
      • Compliance
    • Manual Integration
      • Manual Integration 7.x.x
    • Manual Integration
      • Manual Integration
    • Migration
      • Migration to SDK version 9.0.0
      • Migration to SDK version 8.2.0
      • Migration to SDK version 7.0.0
      • Migration to SDK version 6.0.0
    • Framework Size Impact
      • Framework Size Impact
    • OS Updates
      • iOS 15
    • Apple TV
      • Apple TV
    • Troubleshooting and FAQs
      • Troubleshooting And FAQs
    • Sample App
      • iOS Sample App
    • Integration with Older Version of SDK
      • Integration
        • Data Center
        • SDK Initialization
        • SDK Integration
        • SDK Integration 7.x.x
        • SDK Initialisation 7.x.x
        • Data Center 7.x.x
      • Data Tracking
        • Session and Source Tracking
        • Tracking events
        • Tracking user attributes
        • Install/Update differentiation
        • Tracking User Attributes 7.x.x
        • Tracking Events 7.x.x
        • Session and Source Tracking 7.x.x
        • Install or Update differentiation 7.x.x
      • Push
        • Basic
          • APNS Certificate/PEM File
          • Push Notifications
          • Push Notifications 7.x.x
          • APNS Certificate/ PEM file 7.x.x
        • Advanced
          • Push Notification Implementation
          • Push Templates
          • Actionable Notifications
          • Real-Time Triggers
          • iOS Notification Center
          • Location Triggered
          • Service and Content Extension
          • Push Notification Implementation 7.x.x
          • Push Templates 7.x.x
          • Actionable Notifications 7.x.x
          • Real-Time Triggers 7.x.x
          • iOS Notification Center 7.x.x
          • Location Triggered 7.x.x
      • In-App Messages
        • JavaScript Bridge for HTML In-Apps
        • In-App Nativ
        • In-App Nativ 7.x.x
        • In-App Nativ 6.x.x
      • Cards
        • Self Handled Cards
        • Cards in iOS
        • Overview
        • Displaying AppInbox/Feeds
        • Card Properties
        • SDK Methods for Cards
        • SDK Installation
        • Cards 7.x.x
      • Checklist
        • Release Checklist
        • Release Checklist 7.x.x
      • Compliance
        • Manual Integration
        • Compliance
        • Compliance 7.x.x
      • Framework Size Impact
        • Framework Size Impact 7.x.x
      • Troubleshooting and FAQs
        • Troubleshooting And FAQs
        • Troubleshooting And FAQs 7.x.x
  • Android SDK
    • SDK Integration
      • Basic Integration
        • Installing Version Catalog
        • Configuring Build Settings
        • Installing Core SDK
        • SDK Initialization
        • Data Center
        • Exclude MoEngage Storage File from Auto-Backup
      • Advanced or Optional
        • Installing SDK using Artifact Id
        • Network Security Configuration
        • Add-On Security
        • Additional Encryption
        • SDK Configuration
    • Data Tracking
      • Basic
        • Enable Advertising Identifier Tracking
        • Track Install or Update
        • Track User Attributes
        • Track Events
      • Advanced or Optional
        • Tracking Locale
        • Configuring Opt-outs
        • Device Identifier Tracking
      • Tracking Uninstalls
    • Push
      • Basic
        • Push Configuration
        • Notification Runtime Permissions
        • Configuring FCM
      • Advanced
        • Callbacks and Customisation
        • Push Display Handled by Application
      • Optional
        • Push AMP+
          • Push AMP Plus Integration
          • Configuring Xiaomi Push
          • Steps to Remove Mi SDK Dependency
          • Configuring HMS Push Kit
        • Push Amplification
        • Device Triggered
        • Location Triggered
        • Notification Center
        • Push Templates
    • In-App Messages
      • In-App NATIV
    • Cards
      • Cards
      • Self Handled Cards
    • Checklist
      • Release checklist
    • Compliance
      • Prepare for Google Play's data disclosure requirements
      • Compliance
    • Integration Validation
      • Integration Verifier
    • Migration
      • Migration to Push Amp Plus 6.x.x
      • Updating to 12.x.xx from 11.x.xx
      • Updating to 11.x.xx from 10.x.xx
      • Migration to 10.x.xx
      • Migrating to 7.x.xx
      • Migration from 4.x to 5.x (One time activity)
      • Moving from Manifest to Code based Integration
      • Migration To Maven Central
      • Migrating from GCM to FCM
      • Migrating from addon-inbox 6.0.2
      • Migrating to Push Amp+ 2.0.00
    • OS Updates
      • Android 12
    • Android TV
      • Android TV
    • Performance
      • SDK Performance
      • SDK Size Impact
    • Troubleshooting and FAQs
      • Troubleshooting and FAQs
      • How to fix Token Drop?
    • Sample App
      • Android Sample App
    • Integration with Older Version of SDK
      • Integration
        • Configuration 11.x.x
        • Integration 11.x.x
        • Integration Using Version Catalog 11.x.x
        • SDK Initialisation 11.x.x
        • Install/Update Differentiation 11.x.x
        • Exclude MoEngage Storage File from Auto-Backup 11.x.x
        • Network Security Configuration 11.x.x
        • Additional Encryption 11.x.x
        • SDK Performance 11.x.x
      • Data Tracking
        • Tracking User Attributes 11.x.x
        • Tracking Events 11.x.x
        • Tracking Locale 11.x.x
        • Tracking Opt-Out 11.x.x
      • Push
        • Push Configuration for Android SDK 11.x.x
        • Push Templates 11.x.x
        • Advanced Push Configuration 11.x.x
        • Push Display Handled by Application 11.x.x
        • Location Triggered 11.x.x
        • Notification Center 11.x.x
        • Notification Center for MoEngage SDK version 11.1.00
        • Notification Customisation 11.x.x
      • Push AMP+
        • Push AMP Plus Integration 11.x.x
        • Configuring Xiaomi Push 11.x.x
        • Configuring HMS Push Kit 11.x.x
      • In-App Messages
        • In-App NATIV 11.x.x
      • Cards
        • Cards 11.x.x
      • Prepare for Release
        • Release checklist 11.x.x
      • Compliance
        • Compliance 11.x.x
      • Troubleshooting and FAQs
        • Troubleshooting and FAQs 11.x.x
      • Configuring Pro-guard
  • Web SDK
    • Web SDK Overview
      • Web SDK Overview
      • Web-SDK Browser Compatibility Matrix
    • Web SDK Integration
      • Basic Integration
        • Web SDK Integration
      • Advanced integration
        • Debugging Mode
        • Cookies used by Web SDK
        • Web SDK Lifecycle Callbacks
        • Bot Traffic Blocking
      • Handle Ad Blockers
    • Data Tracking
      • Web SDK Data Tracking Introduction
      • Web SDK User Attributes Tracking
      • Web SDK Events Tracking
    • Web Push
      • Safari Web Push for iOS and iPadOS
      • Web Push Overview
      • Configure and Integrate Web Push
      • Configure Self-Handled Opt-In
      • Opted Out Users
    • Onsite Messaging
      • Configure and Integrate On-site Messaging
    • Web Personalization
      • Untitled
      • Configure and Integrate Web Personalization
    • Cards
      • Cards
      • Self Handled Cards
    • Integration Validation
      • Web Push Notifications Integration Validation
    • Other Supported Web SDK Integration
      • Google Tag Manager (GTM) Templates
      • Smart TV integration
      • Integrating and using MoEngage Web SDK through Google Tag Manager (GTM)
      • Untitled
      • Single Page App (SPA) Support
      • Integrating with other Web Frameworks
      • Configure and Integrate AMP Event Analytics
      • Configure and Integrate AMP Web Push
  • Personalize SDK
    • SDK Integration
      • Web Personalization - V2
  • Ecommerce Platforms
    • Shopify
      • Shopify 2.0
      • Events and User Data Tracking
      • User Data Sync
      • Sync Product Catalog
      • Validate Integration
      • User Profile Management with Shopify
      • FAQs
      • Shopify Privacy and Data Protection
      • Shopify (E-Com Platform) - V2
      • Shopify (E-Com Platform)
    • Woo Commerce
      • Woo Commerce
    • Magento
      • Magento
  • Shopify Integration
    • Shopify
      • Shopify 2.0
      • Events and User Data Tracking
      • Data Sync
      • Validate Integration
      • User Profile Management with Shopify
      • FAQs
      • Shopify (E-Com Platform) - V2
      • Shopify (E-Com Platform)
  • React Native SDK
    • Overview
      • Getting Started with React Native SDK
    • SDK Integration
      • SDK Installation
        • Framework Dependency
        • Android
        • iOS
      • SDK Initialization
        • Framework Initialization
        • Android
        • iOS
      • Limitations
    • Data Tracking
      • Enable Advertising Identifier Tracking
      • Install/Update
      • Tracking User Attributes
      • Tracking Events
      • Delete User From MoEngage Server
    • Push
      • Basic
        • Android Push Configuration
        • Android Notification Runtime Permissions
        • iOS Push Configuration
        • Push Callback
      • Optional
        • Location Triggered
        • Notification Center
    • In App Messages
      • InApp NATIV
    • Cards
      • Installation
        • Framework Dependency
        • Android
        • iOS
      • Initialization
        • Framework Initialization
      • Self Handled Cards
      • Cards Data Payload
    • TV
      • TV Support
    • Sample App
      • React Native Sample App
    • Integration with Older SDK Version
      • SDK Integration
        • SDK Installation>
          • Framework Dependency
          • Android
          • iOS
          • Framework Dependency 7.x.x
          • Android 7.x.x
          • iOS 7.x.x
        • SDK Initialization>
          • Framework Initialization
          • Android
          • iOS
          • Framework Initialization 7.x.x
          • Android 7.x.x
          • iOS 7.x.x
        • Limitations
        • Limitations 7.x.x
      • Data Tracking
        • Enable Advertising Identifier Tracking
        • Install/Update
        • Tracking User Attributes
        • Tracking Events
        • Enable Advertising Identifier Tracking 7.x.x
        • Install/Update 7.x.x
        • Tracking User Attributes 7.x.x
        • Tracking Events 7.x.x
      • Push
        • Basic
          • Android Push Configuration
          • iOS Push Configuration
          • Push Callback
          • Android Push Configuration 7.x.x
          • iOS Push Configuration 7.x.x
          • Push CallBack 7.x.x
        • Optional
          • Notification Center
          • Notification Center 7.x.x
      • InApp Messages
        • InApp NATIV
        • InApp NATIV 7.x.x
  • Flutter SDK
    • Overview
      • Getting Started with Flutter SDK
    • SDK Integration
      • SDK Installation
        • Framework Dependency
        • Android
        • iOS
      • SDK Initialization
        • Framework Initialization
        • Android SDK Initialization
        • iOS SDK Initialization
        • Web SDK Initialization
      • Limitations
    • Data Tracking
      • Delete User From MoEngage Server
      • Enable Advertising Identifier Tracking
      • Install/Update Differentiation
      • Tracking User Attributes
      • Tracking Events
    • Push
      • Basic
        • Android Push Configuration
        • Android Notification Runtime Permissions
        • iOS Push Configuration
        • Push Callback
      • Optional
        • Location Triggered
        • Notification Center
    • In-App Messages
      • InApp NATIV
    • Cards
      • Self Handled Cards
    • Troubleshooting and FAQs
      • Troubleshooting and FAQs
    • Sample App
      • Flutter Sample App
    • Integration with Older SDK Version
      • Framework Dependency
        • SDK Installation>
          • Web 5.2.0
          • iOS 5.2.0
          • Android 5.2.0
          • Framework Dependency 5.2.0
          • Web
          • iOS
          • Android
          • Framework Dependency
          • SDK Installation 4.x.x
          • Android 4.x.x
          • iOS 4.x.x
          • Web 4.x.x
        • SDK Initialization>
          • Web SDK Initialization 5.2.0
          • iOS SDK Initialization 5.2.0
          • Android SDK Initialization 5.2.0
          • Framework Initialization 5.2.0
          • Web SDK Initialization
          • iOS SDK Initialization
          • Android SDK Initialization
          • Framework Initialization
          • Framework Initialization 4.x.x
          • Android SDK Initialization 4.x.x
          • iOS SDK Initialization 4.x.x
          • Web SDK Initialization 4.x.x
      • Data Tracking
        • Tracking Events 5.2.0
        • Enable Advertising Identifier Tracking 5.2.0
        • Tracking User Attributes 5.2.0
        • Install/Update Differentiation
        • Tracking Events
        • Enable Advertiser Identifier Tracking
        • Tracking User Attributes
        • Install/Update Differentiation
        • Enable Advertising Identifier Tracking 4.x.x
        • Install/Update Differentiation 4.x.x
        • Tracking User Attributes 4.x.x
        • Tracking Events 4.x.x
      • Push
        • Basic
          • Push Callback
          • iOS Push Configuration 5.2.0
          • Android Push Configuration 5.2.0
          • Push Callback
          • iOS Push Configuration
          • Android Push Configuration
          • Android Push Configuration 4.x.x
          • iOS Push Configuration 4.x.x
          • Push Callback 4.x.x
        • Optional
          • Notification Center 5.2.0
          • Location Triggered 5.2.0
          • Notification Center
          • Location Triggered
          • Notification Center 4.x.x
      • In-App Messages
        • InApp NATIV 5.2.0
        • InApp NATIV
        • InApp NATIV 4.x.x
  • Cordova SDK
    • SDK Integration
      • SDK Installation
        • Framework Dependency
        • Android SDK Installation
        • iOS Installation
      • SDK Initialization
        • Framework Initialization
        • Android SDK Initialization
        • iOS SDK Initialization
      • Limitations
    • Data Tracking
      • Delete User From MoEngage Server
      • Enable Advertising Identifier Tracking
      • Install/Update differentiation
      • Tracking User Attributes
      • Tracking Events
    • Push
      • Basic
        • Android Notification Runtime Permissions
        • iOS Push Configuration 7.x.x
        • Android Push Configuration
        • iOS Push Configuration
        • Push Callback
      • Optional
        • Location Triggered
    • In App Messages
      • InApp NATIV
    • Migration
      • Migrating to 4.x.x
    • Integration with Older SDK Version
      • SDK Integration
        • SDK Installation>
          • Framework Dependency
          • Android SDK Installation
          • iOS SDK Installation
          • Framework Dependency 7.x.x
          • Android SDK Installation 7.x.x
          • iOS Installation 7.x.x
        • SDK Initialization>
          • Android SDK Initialization
          • Framework Initialization
          • Framework Initalization 7.x.x
          • Android SDK Initialization 7.x.x
          • iOS SDK Initialization 7.x.x
        • iOS SDK Initialization
        • SDK Integration
        • Limitations
      • Data Tracking
        • Tracking Events
        • Tracking User Attributes
        • Install/Update Differentiation
        • Enable Advertiser Identifier Tracking
        • Enable Advertising Identifier Tracking 7.x.x
        • Tracking User Attributes 7.x.x
        • Tracking Events 7.x.x
        • Install/Update differentiation 7.x.x
      • Push
        • Basic
          • Push Callback
          • Push Callback 7.x.x
          • Android Push Configuration 7.x.x
        • iOS Push Configuration
        • Android Push Configuration
      • In App Messages
        • InApp NATIV
        • InApp NATIV 7.x.x
  • Unity SDK
    • SDK Integration
      • SDK Installation
        • SDK Installation
      • SDK Initialization
        • SDK Initialization
        • Android SDK Initialization
        • iOS SDK Initialization
      • Limitations
    • Data Tracking
      • Delete User From MoEngage Server
      • Enable Advertising Identifier Tracking
      • Install/Update Differentiation
      • Tracking User Attributes
      • Tracking Events
    • Push
      • Basic
        • Android Push Configuration
        • Android Notification Runtime Permissions
        • iOS Push Configuration
        • Push Callback
      • Optional
        • Configuring Push Templates
        • Location Triggered
    • In App Messages
      • InApp NATIV
    • Compliance
      • Compliance
    • Integration with Older SDK Version
      • SDK Integration
        • SDK Installation>
          • SDK Installation 2.x.x
        • SDK Initialization>
          • SDK Initialization 2.x.x
          • Android SDK Initialization 2.x.x
          • iOS SDK Initialization 2.x.x
        • Limitations 2.x.x
      • Data Tracking
        • Tracking User Attributes 2.x.x
        • Enable Advertising Identifier Tracking 2.x.x
        • Install/Update Differentiation 2.x.x
        • Tracking Events 2.x.x
      • Push
        • Basic
          • Android Push Configuration 2.x.x
          • iOS Push Configuration 2.x.x
          • Push Callback 2.x.x
          • Configuring Push Templates 2.x.x
        • Optional
          • Location Triggered 2.x.x
      • InApp Messages
        • InApp NATIV 2.x.x
      • Compliance
        • Compliance 2.x.x
  • Capacitor SDK
    • SDK Integration
      • SDK Installation
        • Framework Dependency
        • Android SDK Installation
        • iOS SDK Installation
      • SDK Initialization
        • Framework Initialization
        • Android SDK Initialization
        • iOS SDK Initialization
    • Data Tracking
      • Delete User From MoEngage Server
      • Enable Advertising Identifier Tracking
      • Install/Update Differentiation
      • Tracking User Attributes
      • Tracking Events
    • Push
      • Basic
        • Android Notification Runtime Permissions
        • Android Push Configuration
        • iOS Push Configuration
        • Push Callback
      • Optional
        • Location Triggered
    • In-App Messages
      • InApp NATIV
    • Sample App
      • Capacitor Sample App
    • Integration with Older SDK Version
      • SDK Integration
        • SDK Installation>
          • Framework Dependency
          • Android SDK Installation
          • iOS SDK Installation
        • SDK Initialization>
          • Framework Initialization
          • Android SDK Initialization
          • iOS SDK Initialization
      • Data Tracking
        • Enable Advertising Identifier Tracking
        • Install/Update Differentiation
        • Tracking User Attributes
        • Tracking Events
      • Push
        • Basic
          • Android Push Configuration
          • iOS Push Configuration
          • Push Callback
        • Optional
          • Location Triggered
      • In-App Messages
        • InApp NATIV
  • Ionic SDK
    • SDK Integration
      • SDK Installation
  • TV and OTT Integrations
    • Roku SDK
      • SDK Integration
        • SDK Installation
        • SDK Initialization
      • Data Tracking
        • Roku Tracking User Attributes
        • Roku Tracking Events
        • Roku Install / Update Differentiation
      • In-App Messages
        • Roku In-Apps Messages - Self Handled
      • Cards
        • Roku Cards - Self Handled
      • Sample App
        • Roku Sample App
    • Getting Started
      • TV and OTT Integrations
  • Components for SDK
    • Multi-Instance Support
      • iOS Support
      • Android Support
    • Tracking
      • Real-time Uninstall Tracking
    • Javascript Bridge
      • JavaScript Bridge for HTML In-Apps
    • Push Notification
      • Push Configuration For Hybrid Applications
  • API
    • Segment Sync
      • Create Segment Sync
    • Cards API
      • Delete Cards API
      • Cards API - Overview
      • Fetch Cards API
    • Postman Collection
      • Postman Collection
    • Content
      • Email templates
        • Version 1
          • Overview - Email Template APIs
          • Create Email Template
          • Get all templates
          • Get a Specific Email Template
          • Bulk Create/Update Template
          • Update a Specific Email Template
        • Version 2
          • Overview - Email Template APIs
          • Create Email Template API
          • Search Email Template API
          • Update Email Template API
      • Push templates
        • Overview
        • Create Push Template API
        • Search Push Template API
        • Update Push Template API
      • SMS templates
        • Overview
        • Create SMS Template API
        • Search SMS Template API
        • Update SMS Template API
      • Content blocks
        • Content block APIs
        • Search content block
        • Get specific content blocks
        • Create content block
        • Update content block
    • Inform
      • Inform API
    • Push
      • Push API
    • WhatsApp
      • Send Message Template API
    • Business Events
      • Overview
      • Create Business Event API
      • Trigger Business Event API
      • Search Business Event API
    • Data
      • Overview
      • Track User
      • Get User
      • Merge User
      • Delete User
      • Create Event
      • Bulk Import
      • Streams
      • Trigger File Imports
      • Install Tracking
      • S3 Data Import
    • GDPR / CCPA
      • GDPR / CCPA API
    • Campaign Report
      • Daily Campaign Report API
      • Campaign Report API
    • Subscription Categories
      • Overview - Subscription Categories API
      • Get Subscription Preferences API
      • Update Subscription Preferences API
      • Bulk Update Subscription Preferences API
    • Resubscribe Email
      • Resubscribe Email API
    • Custom Segment
      • File
        • File Segment API
      • Filter
        • Overview
        • Create Custom Segment
        • Get Custom Segment by ID
        • List Custom Segments API
        • Update Custom Segment API
      • Cohort/Audience
        • Cohort/ Audience Sync(Revamped)
        • Cohort/ Audience Sync
    • Custom Templates
      • Email
        • Create Email Template API
  • Partner Integrations
    • Appsflyer
      • Appsflyer Integration
    • Adjust
      • Adjust Integration
    • Branch
      • Branch Integration
    • Firebase
      • Getting FCM Server Key
      • FCM Authentication
    • Segment
      • Segment Integration : Introduction
      • Integrating MoEngage with Segment in iOS
      • Integrating MoEngage with Segment in Android
      • Integrating MoEngage with Segment on Web
    • Huawei
      • Configuring Huawei Push on MoEngage
    • Xiaomi
      • Note on Policy Upgrade from Xiaomi
      • Configuring Xiaomi Push on MoEngage
  • Release Notes
    • iOS SDK
      • Changelog
    • Android SDK
      • Changelog
    • Web SDK
      • Changelog
    • React Native SDK
      • Changelog
    • Flutter SDK
      • Changelog
    • Cordova SDK
      • Changelog
    • Unity SDK
      • Changelog
    • Capacitor SDK
      • Changelog
    • Segment Integration
      • iOS Swift Changelog
      • Android Kotlin SDK Changelog
      • iOS SDK Changelog
      • Android SDK Changelog
      • React-Native Plugin Changelog
Toggle navigation
  1. Developer Guide
  2. API
  3. Campaign API

Campaign API

Use these APIs to create and manage your campaigns. Currently, these APIs support only Email campaigns.

  • Campaign Meta and Reachability API
  • Personalized Preview
  • Create Campaigns
  • Update Campaigns
  • Get Campaign Details
  • Change Campaign Status
  • Test a Campaign
  • Get Child Campaigns of Periodic and Triggered Campaigns
MoEngage © Developer Guide

Copied to clipboard