MoEngage Update Campaigns API
The Update Campaigns API from MoEngage — 5 operation(s) for update campaigns.
MoEngage Update 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 Update Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 5 operations across 5 paths, and defines 113 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.
5 operations
5 paths
113 schemas
3 PATCH1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
MoEngage Update Campaigns API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
BasicAuth— Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'. - Username: Use your MoEnga…
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 3 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Update Campaigns 5
PATCH
/v5/campaigns/{campaign_id}
Update Campaign (V5)
PATCH
/v5/campaigns/{campaign_id}/status
Update Campaign Status (V5)
PATCH
/campaigns/{campaign_id}
Update Campaign (V1 — Legacy)
POST
/campaigns/status
Change Campaign Status
PUT
/global-control-group/users
Update Global Control Group
Schemas 113
The contract defines 113 schemas that model the data the API accepts and returns. The most detailed are AndroidBasicDetails_2 (19 properties), AndroidBasicDetails (19 properties), EmailComponentPatchRequest (16 properties), PushComponentPatchRequest (15 properties). Each schema is shown below with its type and property counts.
EmailComponentPatchRequest
object
Update one or more components of an Email campaign draft. Only fields you include are changed, omitted fields retain their current values. When updating a nest…
16 properties
GoalEventAttribute
object
Attributes associated with the conversion goal event.
10 properties
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
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
PeriodicDetails
object
Configuration for periodic campaigns. Required for PERIODIC campaigns. For runnable Daily, Weekly, Monthly (specific dates), and Monthly (first Monday) example…
6 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
PushComponentPatchRequest
object
Update one or more components of a Push campaign draft. Only fields you include are changed, omitted fields retain their current values. When updating a nested…
15 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
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
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
UserAttributeFilter
object
Filter based on user attributes.
10 properties
CampaignStatusV5Request
object
Changes the status of a single published campaign. One campaign ID per request.
2 properties
1 required
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
CampaignStatusTransitionData
object
Returned after a successful status transition on a published campaign.
2 properties
2 required
IOSPushContent
object
iOS push notification content.
7 properties
WebBasicDetails
object
Basic details for the Web push notification.
5 properties
CustomSegmentFilter
object
Filter using a custom segment.
3 properties
AndroidButton
object
Action button configuration for Android push notifications.
5 properties
CampaignPatchV5Request
Used for component-level edits on a campaign draft.
IOSTemplateBackup
object
Fallback notification content for when the template cannot be rendered. Required for: Stylized Basic and Simple Image Carousel templates
9 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
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
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
CampaignPatchAcceptedData
object
Returned after a successful component PATCH.
1 property
1 required
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
EmailDeliveryControls
object
Controls for Email campaign delivery behavior. For runnable examples, refer to [Email delivery controls](/api/campaigns/audience-scheduling-delivery-referencee…
5 properties
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
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
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
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
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
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
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
ConversionGoalDetails_2
object
Configuration for tracking campaign conversion goals.
2 properties
PeriodicDetails_2
object
Configuration for periodic campaigns. Required for PERIODIC campaigns.
6 properties
AdvancedDetails_2
object
Advanced campaign settings.
2 properties
PushDeliveryControls_2
object
Controls for Push campaign delivery behavior.
10 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
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
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
UTMParams_2
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
PushTriggerCondition_2
object
Trigger condition details for Push event-triggered campaigns. Required for EVENTTRIGGERED campaigns.
8 properties
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
CustomSegmentFilter_2
object
Filter using a custom segment.
3 properties
2 required
AndroidButton_2
object
Action button configuration for Android push notifications.
5 properties
3 required
PushCampaignUpdateRequest
object
13 properties
2 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
CampaignAudienceLimit_2
object
Configuration for limiting campaign audience.
3 properties
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
CampaignUpdateRequest
GlobalControlGroupRequest
object
Request to add or remove users from the Global Control Group (GCG).
4 properties
4 required
ActionFilter_2
object
Filter based on user actions/events.
6 properties
2 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
SchedulingDetails_2
object
Defines when the campaign should be sent. All date-time values must be passed in UTC.
6 properties
1 required
PushBasicDetails
object
Contains the basic information about the Push campaign.
9 properties
3 required
EmailDeliveryControls_2
object
Controls for Email campaign delivery behavior.
5 properties
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
UserTimezoneDetails_2
object
Configuration for sending in the user's timezone.
2 properties
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
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
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
CampaignStatusChangeRequest
object
You can request to change the status of one or more campaigns.
3 properties
3 required
EmailCampaignUpdateRequest
object
14 properties
2 required
EmailTriggerCondition_2
object
Trigger condition details for Email event-triggered campaigns. Required for EVENTTRIGGERED campaigns.
7 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from MoEngage 12
Other APIs MoEngage publishes across the network.
MoEngage MCP Server
MoEngage Bulk API
MoEngage Business Events API
MoEngage Campaign Reports API
MoEngage Cards API
MoEngage Catalog API
MoEngage Cohort Sync API
MoEngage Content Blocks API
MoEngage Coupon Files API
MoEngage Coupon Lists API
MoEngage Create Campaigns API
MoEngage Dashboards API
#Update Campaigns
Where this information came from
This is an independent, third-party profile of MoEngage Update Campaigns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.