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
GoalEventAttribute
object
Attributes associated with the conversion goal event.
10 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
ConversionGoalDetails
object
Configuration for tracking campaign conversion goals. For runnable single-goal and multi-goal examples, refer to [Conversion goal tracking](/api/campaigns/audi…
2 properties
AdvancedDetails
object
Advanced Push delivery settings, including notification expiration and per-platform priority. For runnable iOS APNS priority and Android priority examples, ref…
2 properties
PushDeliveryControls
object
Controls for Push campaign delivery behavior. For per-delivery-type runnable examples (throttle, event-triggered, device-triggered, location-triggered, queuing…
13 properties
SegmentationDetails
object
Defines the target audience for the campaign. For included/excluded filter combinations, filter primitives (userattributes, actions, customsegments), and opt-o…
4 properties
PeriodicDetails
object
Configuration for periodic campaigns. Required for PERIODIC campaigns. For runnable Daily, Weekly, Monthly (specific dates), and Monthly (first Monday) example…
6 properties
ControlGroupDetails
object
Configuration for control groups. For runnable campaign-control-group and global-control-group examples, refer to [Control groups](/api/campaigns/audience-sche…
3 properties
UserAttributeFilter
object
Filter based on user attributes.
10 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
CampaignSearchResponseData
object
Search and meta list endpoints wrap rows under data.campaigns.
1 property
1 required
BTSDetails
object
Best Time to Send (BTS) configuration. BTS selects an optimal send time per user based on historical engagement patterns. For the field schema and required-whe…
4 properties
UTMParams
object
UTM parameters for tracking campaign performance. The five standard keys (utmsource, utmmedium, utmcampaign, utmterm, utmcontent) are explicitly defined. Custo…
6 properties
AndroidPushContent
object
Android push notification content.
8 properties
IOSButton
object
Action button configuration for iOS push notifications.
1 property
PushTriggerCondition
object
Trigger condition details for Push event-triggered, device-triggered, and related campaigns. Required for EVENTTRIGGERED, DEVICETRIGGERED, and LOCATIONTRIGGERE…
8 properties
IOSAdvanced
object
Platform-level advanced settings for push delivery - TTL, priority, badge count, and similar controls.
5 properties
CustomSegmentFilter
object
Filter using a custom segment.
3 properties
WebBasicDetails
object
Basic details for the Web push notification.
5 properties
IOSPushContent
object
iOS push notification content.
7 properties
AndroidButton
object
Action button configuration for Android push notifications.
5 properties
CampaignMetaResponseV5
object
Campaign metadata including basic information and reachability details. V1 compatibility: - All field names are preserved from the V1 Get Campaign Meta respons…
15 properties
IOSTemplateBackup
object
Fallback notification content for when the template cannot be rendered. Required for: Stylized Basic and Simple Image Carousel templates
9 properties
CampaignMetaListResponseData
object
The response does not include a totalcount field. To determine whether you have reached the last page, check whether the number of items returned is less than…
1 property
1 required
V5ErrorEnvelope
object
2 properties
SearchV5Request
object
6 properties
2 required
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
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
CampaignAudienceLimit
object
Configuration for capping the number of users a campaign can reach (max-send). Campaign Audience Limit (also called max-send) caps how many users a single camp…
4 properties
EmailBasicDetailsV5
object
Identifying metadata for the Email campaign, including name, team, tags, and subscription category. Conditional requirements: name, contenttype, userattributei…
7 properties
Goal
object
A single conversion goal configuration.
6 properties
ActionFilter
object
Filter based on user actions/events. Use inside segmentationdetails.includedfilters.filters or triggercondition.includedfilters.filters.
6 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
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
AndroidBasicDetails
object
Basic details for the Android push notification. Fields vary by templatetype. All templates support common fields like title, message, defaultclickaction.
19 properties
EmailDeliveryControls
object
Controls for Email campaign delivery behavior. For runnable examples, refer to [Email delivery controls](/api/campaigns/audience-scheduling-delivery-referencee…
5 properties
CampaignSearchFieldsV5
object
Filter criteria for searching campaigns. The following filter field names changed from V1 to V5: - id (V1, string) is ids in V5 (array of strings). Pass a sing…
9 properties
SchedulingDetails
object
Defines when the campaign should be sent. For per-delivery-type runnable payloads (ASAP, ATFIXEDTIME, SENDINBTS, SENDINUSERTIMEZONE, and PERIODIC with periodic…
8 properties
EmailContent
object
Email campaign content.
12 properties
CampaignDetailsResponse
object
Detailed information about a campaign returned by GET /v5/campaigns/{campaignid} and POST /v5/campaigns/search. Identifier change from V1 to V5: - In V1, the c…
27 properties
FilterGroup
object
A group of filters combined with a logical operator. For detailed segmentation payload and supported fields, refer to [Create Custom Segment](https://developer…
2 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
UserTimezoneDetails
object
Configuration for sending in the user's timezone. For the field schema and required-when-SENDINUSERTIMEZONE rule, refer to [User timezone](/api/campaigns/audie…
2 properties
MetaV5Request
object
5 properties
2 required
CampaignMetaSearchFieldsV5
object
Filter criteria for retrieving campaign metadata.
8 properties
EmailTriggerCondition
object
Trigger condition details for Email event-triggered campaigns. Required for EVENTTRIGGERED campaigns. For per-delay-type runnable payloads (ASAP, DELAY with AF…
7 properties
GetChildCampaignsRequest
object
You can request to retrieve child campaign execution details.
3 properties
3 required
CampaignMetaResponse
object
Campaign metadata including basic information and reachability details.
13 properties
ConversionGoalDetails_2
object
Configuration for tracking campaign conversion goals.
2 properties
PeriodicDetails_2
object
Configuration for periodic campaigns. Required for PERIODIC campaigns.
6 properties
SegmentationDetails_2
object
Defines the target audience for the campaign.
4 properties
ControlGroupDetails_2
object
Configuration for control groups.
3 properties
UserAttributeFilter_2
object
Filter based on user attributes.
9 properties
4 required
BTSDetails_2
object
Best Time to Send (BTS) configuration. BTS provides a prescriptive time slot to send a campaign to increase the chance of user interaction.
4 properties
UTMParams_2
object
UTM parameters for tracking campaign performance.
6 properties
2 required
CampaignMetaRequest
object
5 properties
3 required
CustomSegmentFilter_2
object
Filter using a custom segment.
3 properties
2 required
CampaignAudienceLimit_2
object
Configuration for limiting campaign audience.
3 properties
ActionFilter_2
object
Filter based on user actions/events.
6 properties
2 required
CampaignSearchFields
object
Filter criteria for searching campaigns.
8 properties
ChildCampaignsResponse
object
Response containing child campaign execution details.
2 properties
SchedulingDetails_2
object
Defines when the campaign should be sent. All date-time values must be passed in UTC.
6 properties
1 required
CampaignMetaSearchFields
object
Filter criteria for retrieving campaign metadata.
8 properties
ErrorResponse
object
1 property
CampaignDetailsResponse_2
object
Detailed information about a campaign.
25 properties
FilterGroup_2
object
A group of filters combined with a logical operator. For detailed segmentation payload and supported fields, refer to [Create Custom Segment](/api/filter-segme…
2 properties
2 required
UserTimezoneDetails_2
object
Configuration for sending in the user's timezone.
2 properties
CampaignSearchRequest
object
6 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MoEngage publishes across the network.
