MoEngage Test Campaigns API is one of 46 APIs that MoEngage publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Test Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
3 operations
across 3 paths,
and defines 80 schemas.
It is described by OpenAPI 3.2.0, at version 2025-11-20.
Requests are made against 2 base URLs: https://api-{dc}.moengage.com/, https://api-{dc}.moengage.com/core-services/v1.
The identity and technical contract details declared by the specification.
EmailCampaignContent
object
Email content, locales, and A/B variations. For full POST /v5/campaigns request examples that include campaigncontent, refer to campaigndeliverytype on EmailCa…
3 properties
KeyValuePair
object
A custom key-value pair attached to the push payload.
2 properties
V5SuccessEnvelope
object
3 properties
Geofences
object
Geofence location details for location-triggered campaigns. Required for LOCATIONTRIGGERED campaigns. For per-triggeredat runnable payloads (ENTRY, EXIT, dwell…
9 properties
7 required
AndroidTimer
object
Timer configuration for Timer and Timer with Progress Bar templates. Required for: TIMER and TIMERWITHPROGRESSBAR templates
6 properties
AndroidTemplateBackup
object
Fallback notification content for when the template cannot be rendered. Required for: Stylized Basic, Simple Image Carousel, Image Banner with Text, Timer, and…
7 properties
PushBasicDetailsV5
object
Identifying metadata for the Push campaign, including name, team, tags, and platform targeting. For field-by-field rules, conditional requirements, and platfor…
9 properties
TestCampaignResultData
object
Result of a test send. data maps composite keys to per-send status objects. message summarizes the overall operation.
2 properties
AndroidPushContent
object
Android push notification content.
8 properties
IOSButton
object
Action button configuration for iOS push notifications.
1 property
TestV5EmailRequest
object
Email test request. Supports two modes: - Inline mode: Supply channel, basicdetails, connector, and campaigncontent directly. Nothing is stored on the server.…
8 properties
1 required
IOSAdvanced
object
Platform-level advanced settings for push delivery - TTL, priority, badge count, and similar controls.
5 properties
IOSPushContent
object
iOS push notification content.
7 properties
WebBasicDetails
object
Basic details for the Web push notification.
5 properties
AndroidButton
object
Action button configuration for Android push notifications.
5 properties
Connector
object
Email connector configuration for sending email campaigns. Required for inline Email test requests and before an Email campaign can be published or sent for te…
2 properties
2 required
IOSTemplateBackup
object
Fallback notification content for when the template cannot be rendered. Required for: Stylized Basic and Simple Image Carousel templates
9 properties
V5ErrorEnvelope
object
2 properties
WebAdvanced
object
Platform-level advanced settings for push delivery - TTL, priority, badge count, and similar controls.
2 properties
WebPushContent
object
Web push notification content.
4 properties
TestV5PushRequest
object
Push test request. Supports two modes: - Inline mode: Supply channel and campaigncontent directly. Nothing is stored on the server. - Draft mode: Supply drafti…
7 properties
1 required
CarouselContent
object
Configuration for image carousel in Simple Image Carousel template. Required for: Simple Image Carousel template
2 properties
IOSBasicDetails
object
Basic details for the iOS push notification.
14 properties
EmailBasicDetailsV5
object
Identifying metadata for the Email campaign, including name, team, tags, and subscription category. Conditional requirements: name, contenttype, userattributei…
7 properties
VariationDetails
object
Configuration for A/B testing variations. For runnable MANUAL (fixed split) and SHERPA (auto-optimized) examples, refer to [A/B test variations](/api/campaigns…
5 properties
PushCampaignContent
object
Push message content, locales, and A/B variations. For full POST /v5/campaigns request examples that include campaigncontent, refer to campaigndeliverytype on…
3 properties
AndroidBasicDetails
object
Basic details for the Android push notification. Fields vary by templatetype. All templates support common fields like title, message, defaultclickaction.
19 properties
PlatformSpecificDetails
object
Platform-specific configuration details for Push. For runnable Android and iOS examples and the mutual-exclusion rule on iOS audience flags, refer to [Platform…
2 properties
TestCampaignMetaV5
object
Test audience and delivery options.
5 properties
2 required
EmailContent
object
Email campaign content.
12 properties
PushContent
object
Push notification content for Android, iOS, and Web platforms.
3 properties
AndroidAdvanced
object
Platform-level advanced settings for push delivery - TTL, priority, badge count, and similar controls.
10 properties
IOSCarouselContent
object
Configuration for image carousel in Simple Image Carousel template. Required for: Simple Image Carousel template
2 properties
WebButton
object
Action button configuration for Web push notifications.
3 properties
PersonalizationDetails
object
Overrides user and event attribute values used to render personalised content during the test send. When supplied, these values replace what would normally be…
2 properties
EmailCampaignContent_2
object
Contains the content and variations for the Email campaign.
3 properties
1 required
KeyValuePair_2
object
A key-value pair for custom data.
2 properties
2 required
PushTestCampaignMeta
object
Metadata for specifying test recipients for Push campaigns.
4 properties
2 required
Geofences_2
object
Geofence location details for location-triggered campaigns. Required for LOCATIONTRIGGERED campaigns.
9 properties
7 required
AndroidTimer_2
object
Timer configuration for Timer and Timer with Progress Bar templates. Required for: TIMER and TIMERWITHPROGRESSBAR templates
6 properties
2 required
AndroidTemplateBackup_2
object
Fallback notification content for when the template cannot be rendered. Required for: Stylized Basic, Simple Image Carousel, Image Banner with Text, Timer, and…
7 properties
4 required
GmailAnnotationsProductCarouselProductSetData
object
Product set configuration for the Gmail Annotations product carousel. Pulls products dynamically from a MoEngage Catalog product set. Required when productcaro…
5 properties
5 required
GmailAnnotationsProductCarousel
object
Product Carousel annotation shown in Gmail's Promotions tab. Use MANUAL to specify products directly in the request, or PRODUCTSET to pull products dynamically…
3 properties
1 required
UTMParams
object
UTM parameters for tracking campaign performance.
6 properties
2 required
GmailAnnotationsProductCarouselManualProduct
object
A single product entry in a manual product carousel. All fields below are required for each product.
7 properties
7 required
AndroidPushContent_2
object
Android push notification content.
8 properties
1 required
IOSButton_2
object
Action button configuration for iOS push notifications.
1 property
1 required
IOSAdvanced_2
object
Advanced configuration options for iOS push notifications.
5 properties
IOSPushContent_2
object
iOS push notification content.
7 properties
1 required
WebBasicDetails_2
object
Basic details for the Web push notification.
5 properties
3 required
EmailCampaignTestRequest
object
8 properties
6 required
AndroidButton_2
object
Action button configuration for Android push notifications.
5 properties
3 required
PersonalizedPreviewRequest
object
4 properties
3 required
IOSTemplateBackup_2
object
Fallback notification content for when the template cannot be rendered. Required for: Stylized Basic and Simple Image Carousel templates
9 properties
2 required
Connector_2
object
Email connector configuration for sending email campaigns.
2 properties
2 required
WebAdvanced_2
object
Advanced configuration options for Web push notifications.
2 properties
WebPushContent_2
object
Web push notification content.
4 properties
2 required
CarouselContent_2
object
Configuration for image carousel in Simple Image Carousel template. Required for: Simple Image Carousel template
2 properties
2 required
IOSBasicDetails_2
object
Basic details for the iOS push notification.
14 properties
2 required
PersonalizedPreviewResponse
object
Response containing the personalized content.
1 property
GmailAnnotations
object
Gmail Annotations shown in Gmail's Promotions tab. Two annotation types are supported: dealcard and productcarousel. These are mutually exclusive — include onl…
5 properties
3 required
VariationDetails_2
object
Configuration for A/B testing variations.
5 properties
2 required
PushCampaignContent_2
object
Contains the content and variations for the Push campaign.
3 properties
1 required
AndroidBasicDetails_2
object
Basic details for the Android push notification. Fields vary by templatetype. All templates support common fields like title, message, defaultclickaction.
19 properties
5 required
PlatformSpecificDetails_2
object
Platform-specific configuration details.
2 properties
TestCampaignSuccessResponse
object
Response after successfully sending a test campaign.
2 properties
PushBasicDetails
object
Contains the basic information about the Push campaign.
9 properties
3 required
EmailContent_2
object
Email campaign content.
13 properties
4 required
GmailAnnotationsDealCard
object
Deal Card annotation shown in Gmail's Promotions tab. All four fields below are required when dealcard is present.
4 properties
4 required
ErrorResponse
object
1 property
EmailBasicDetails
object
Contains the basic information about the Email campaign.
9 properties
3 required
AndroidAdvanced_2
object
Advanced configuration options for Android push notifications.
10 properties
PushCampaignTestRequest
object
6 properties
5 required
IOSCarouselContent_2
object
Configuration for image carousel in Simple Image Carousel template. Required for: Simple Image Carousel template
2 properties
2 required
WebButton_2
object
Action button configuration for Web push notifications.
3 properties
1 required
GmailAnnotationsProductCarouselManualData
object
Manual product list for the Gmail Annotations product carousel. Required when productcarousel.type is MANUAL. Minimum 2 products required.
2 properties
2 required
EmailTestCampaignMeta
object
Metadata for specifying test recipients for Email campaigns.
4 properties
2 required
PersonalizationDetails_2
object
Override values for personalizing campaign content during testing. Important: - When you pass personalization details in the personalizationdetails object of t…
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MoEngage publishes across the network.
