openapi: 3.2.0 info: title: Moengage Get Campaign Details API version: '2025-11-20' contact: name: MoEngage Developer Team email: support@moengage.com url: https://developers.moengage.com description: 'Operations tagged Get Campaign Details across 2 of this provider''s published API definitions: moengage-campaign-draft-openapi.yml, moengage-campaigns-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api-{dc}.moengage.com/ description: MoEngage Campaigns API Server variables: dc: default: '01' description: Data center (DC) segment in the hostname. Replace `OX` with your workspace DC (01–06 or 101). See [Data centers](/api/introduction#data-centers). - url: https://api-{dc}.moengage.com/core-services/v1 description: MoEngage Campaigns API Server variables: dc: default: '01' description: The ‘dc’ in the API Endpoint URL refers to the MoEngage Data Center (DC). MoEngage hosts each customer in a different DC. You can find your DC number and replace the value of ‘dc’ in the URL by referring to the DC and API endpoint mapping [here](/api/introduction#data-centers). Your MoEngage Data Center (DC) can be 01, 02, 03, 04, 05, 06, or 101. security: - BasicAuth: [] tags: - name: Get Campaign Details paths: /v5/campaigns/{campaign_id}: get: operationId: get_single_campaign_v5 summary: Get Campaign (V5) description: 'Returns the full configuration and current status of a single campaign by its ID. ' x-mint: content: ' **SMS campaigns:** SMS campaigns are returned by this endpoint; the response `channel` field will be `SMS`. The `connector` and `sender_name` fields carry SMS-specific details. SMS campaigns can be retrieved but must be created and managed through the MoEngage dashboard or V1 APIs in the interim. #### Rate Limits | Rate Limit Name | Rate Limit | | :--- | :--- | | Get campaign per second | The total number of get campaign requests per second per client allowed is 10. | | Get campaign per minute | The total number of get campaign requests per minute per client allowed is 100. | | Get campaign per hour | The total number of get campaign requests per hour per client allowed is 6000. | **Notes** * Breaching the limits will reject the request. * Per-hour limits use a rolling window of the last 1 hour. ' x-codeSamples: - lang: Shell label: Get campaign by ID (cURL) source: "curl -X GET 'https://api-{dc}.moengage.com/v5/campaigns/{{campaign_id}}' \\\n -H 'Authorization: Basic {{auth_token}}' \\\n -H 'MOE-APPKEY: {{workspace_id}}' \\\n -H 'X-MOE-Request-Id: {{request_id}}'\n" - lang: Shell label: Get an SMS campaign (cURL) source: "curl -X GET 'https://api-{dc}.moengage.com/v5/campaigns/{{sms_campaign_id}}' \\\n -H 'Authorization: Basic {{auth_token}}' \\\n -H 'MOE-APPKEY: {{workspace_id}}' \\\n -H 'X-MOE-Request-Id: {{request_id}}' \n" tags: - Get Campaign Details parameters: - $ref: '#/components/parameters/MOE-APPKEY' - $ref: '#/components/parameters/X-MOE-Request-Id' - name: campaign_id in: path required: true description: Raw 24-char ObjectId of the campaign to retrieve. schema: type: string examples: get_campaign_by_id: summary: Get campaign by ID value: '{{campaign_id}}' get_sms_campaign: summary: Get an SMS campaign value: '{{sms_campaign_id}}' responses: '200': description: Campaign details retrieved successfully. content: application/json: schema: allOf: - $ref: '#/components/schemas/V5SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/CampaignDetailsResponse' examples: scheduled_push_campaign: summary: Scheduled one-time Push campaign (Android + iOS) value: response_id: abc-100 type: campaign data: id: 64a1b2c3d4e5f6a7b8c9d0e1 campaign_id: 64a1b2c3d4e5f6a7b8c9d0e1 status: SCHEDULED channel: PUSH campaign_delivery_type: ONE_TIME created_by: marketer@example.com updated_by: marketer@example.com created_at: '2024-07-04 08:00:54.847000' updated_at: '2024-07-04 09:15:00.000000' basic_details: name: Summer Sale Push platforms: - ANDROID - IOS tags: - promotional - seasonal team: Growth Team campaign_content: content: push: android: template_type: BASIC basic_details: title: Summer Sale — Up to 50% off message: Shop now before the sale ends. default_click_action: DEEPLINKING default_click_action_value: https://example.com/sale ios: template_type: BASIC basic_details: title: Summer Sale — Up to 50% off message: Shop now before the sale ends. default_click_action: DEEPLINKING default_click_action_value: https://example.com/sale scheduling_details: delivery_type: SCHEDULED schedule_time: '2024-11-28T12:00:00' time_zone: UTC segmentation_details: included_filters: filter_operator: and filters: - filter_type: custom_segments name: segment id: seg_abc123 delivery_controls: bypass_dnd: false ignore_frequency_capping: false utm_params: utm_source: moengage utm_medium: push utm_campaign: summer_sale_2024 active_email_campaign: summary: Active periodic Email campaign (promotional) value: response_id: abc-101 type: campaign data: id: 64a1b2c3d4e5f6a7b8c9d0e2 campaign_id: 64a1b2c3d4e5f6a7b8c9d0e2 status: ACTIVE channel: EMAIL campaign_delivery_type: PERIODIC created_by: marketer@example.com updated_by: marketer@example.com created_at: '2024-01-01 08:00:00.000000' updated_at: '2024-06-15 10:30:00.000000' basic_details: name: Weekly Newsletter content_type: PROMOTIONAL subscription_category: newsletter user_attribute_identifier: Email (Standard) tags: - newsletter team: Retention Team connector: connector_type: SENDGRID connector_name: SendgridPrimary campaign_content: content: email: subject: Your weekly digest is here preview_text: See what's new this week sender_name: MoEngage Team from_address: hello@example.com reply_to_address: support@example.com scheduling_details: delivery_type: PERIODIC frequency: WEEKLY schedule_time: 09:00:00 time_zone: America/New_York segmentation_details: included_filters: filter_operator: and filters: - filter_type: custom_segments name: segment id: seg_xyz789 utm_params: utm_source: moengage utm_medium: email utm_campaign: weekly_newsletter campaign_audience_limit: is_campaign_audience_limit_enabled: false '400': $ref: '#/components/responses/V5ValidationError' '401': $ref: '#/components/responses/V5Unauthorized' '404': description: The requested campaign does not exist or does not belong to the authenticated workspace. content: application/json: schema: $ref: '#/components/schemas/V5ErrorEnvelope' example: response_id: abc-404 error: code: NOT_FOUND message: Campaign not found. details: [] '500': $ref: '#/components/responses/V5InternalError' servers: - url: https://api-{dc}.moengage.com/ description: MoEngage Campaigns API Server variables: dc: default: '01' description: Data center (DC) segment in the hostname. Replace `OX` with your workspace DC (01–06 or 101). See [Data centers](/api/introduction#data-centers). /v5/campaigns/search: post: operationId: search_campaigns_v5 summary: Search Campaigns (V5) description: 'Returns the full V5 campaign payload for all campaigns that match the specified filters. Supports pagination and filtering by channel, status, tags, name, IDs, dates, delivery type, and creator. ' x-mint: content: '#### Rate Limits | Rate Limit Name | Rate Limit | | :--- | :--- | | Search campaign per second | The total number of search campaign requests per second per client allowed is 10. | | Search campaign per minute | The total number of search campaign requests per minute per client allowed is 100. | | Search campaign per hour | The total number of search campaign requests per hour per client allowed is 6000. | **Notes** * Breaching the limits will reject the request. * Per-hour and per-day limits use a rolling window of the last 1 hour and last 24 hours respectively. ' tags: - Get Campaign Details parameters: - $ref: '#/components/parameters/MOE-APPKEY' - $ref: '#/components/parameters/X-MOE-Request-Id' - $ref: '#/components/parameters/Idempotency-Key-Required' requestBody: description: 'Provide the search criteria and pagination parameters for finding campaigns. ' required: true content: application/json: schema: $ref: '#/components/schemas/SearchV5Request' examples: filter_by_channel: summary: Filter by channel value: request_id: '{{request_id}}' limit: 15 page: 1 campaign_fields: channels: - EMAIL filter_by_delivery_type: summary: Filter by delivery type value: request_id: '{{request_id}}' limit: 15 page: 1 campaign_fields: campaign_delivery_type: - ONE_TIME filter_by_creation_date_range: summary: Filter by creation date range value: request_id: '{{request_id}}' limit: 15 page: 1 campaign_fields: created_date: from_date: '{{from_date}}' to_date: '{{to_date}}' filter_by_campaign_id: summary: Filter by campaign ID value: request_id: '{{request_id}}' limit: 1 page: 1 campaign_fields: ids: - '{{campaign_id}}' filter_by_campaign_name: summary: Filter by campaign name value: request_id: '{{request_id}}' limit: 15 page: 1 campaign_fields: name: '{{campaign_name_partial}}' filter_by_creator: summary: Filter by creator value: request_id: '{{request_id}}' limit: 15 page: 1 campaign_fields: created_by: - '{{creator_email}}' filter_multiple: summary: Filter with multiple fields combined value: request_id: '{{request_id}}' limit: 15 page: 1 campaign_fields: channels: - PUSH campaign_delivery_type: - ONE_TIME status: - ACTIVE - SCHEDULED created_by: - '{{creator_email}}' created_date: from_date: '{{from_date}}' to_date: '{{to_date}}' tags: - '{{tag_name}}' include_archived: summary: Include archived campaigns value: request_id: '{{request_id}}' limit: 15 page: 1 campaign_fields: channels: - PUSH - EMAIL include_archive_campaigns: true responses: '200': description: Campaigns matching the filter criteria. content: application/json: schema: allOf: - $ref: '#/components/schemas/V5SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/CampaignSearchResponseData' examples: push_results: summary: Push campaign results value: response_id: resp-search-001 type: campaign data: campaigns: - id: 64a1b2c3d4e5f6a7b8c9d0e1 campaign_id: 64a1b2c3d4e5f6a7b8c9d0e1 status: ACTIVE channel: PUSH campaign_delivery_type: PERIODIC created_by: marketer@example.com created_at: '2024-01-01 08:00:00.000000' updated_at: '2024-06-01 10:00:00.000000' basic_details: name: Weekly Engagement Push platforms: - ANDROID - IOS tags: - engagement team: Growth Team email_results: summary: Email campaign results value: response_id: resp-search-002 type: campaign data: campaigns: - id: 64a1b2c3d4e5f6a7b8c9d0e2 campaign_id: 64a1b2c3d4e5f6a7b8c9d0e2 status: SCHEDULED channel: EMAIL campaign_delivery_type: ONE_TIME created_by: marketer@example.com created_at: '2024-07-04 08:00:54.847000' updated_at: '2024-07-04 09:15:00.000000' basic_details: name: Summer Sale Email content_type: PROMOTIONAL subscription_category: promotions user_attribute_identifier: Email (Standard) tags: - promotional - seasonal connector: connector_type: SENDGRID connector_name: SendgridPrimary '400': $ref: '#/components/responses/V5ValidationError' '401': $ref: '#/components/responses/V5Unauthorized' '500': $ref: '#/components/responses/V5InternalError' servers: - url: https://api-{dc}.moengage.com/ description: MoEngage Campaigns API Server variables: dc: default: '01' description: Data center (DC) segment in the hostname. Replace `OX` with your workspace DC (01–06 or 101). See [Data centers](/api/introduction#data-centers). /v5/campaigns/meta: post: operationId: get_campaign_meta_v5 summary: Get Campaign Meta (V5) description: 'Returns lightweight metadata for one or more campaigns without loading their full configuration. ' x-mint: content: '#### Supported Channels - Email - Push - SMS - WhatsApp - Facebook - Google Ads - Connectors #### Reachability Information - Available only for **scheduled** campaigns (one-time, business event-triggered, and event-triggered). - Provides estimated user count that will receive the campaign. - Calculated once daily and cached for 24 hours. Multiple API calls within the same day return the cached value. - May vary due to app installations/uninstalls or subscription changes. #### Rate Limits | Rate Limit Name | Rate Limit | | :--- | :--- | | get campaign meta per second | The total number of get campaign meta requests per second per client allowed is 10. | | get campaign meta per minute | The total number of get campaign meta requests per minute per client allowed is 100. | | get campaign meta per hour | The total number of get campaign meta requests per hour per client allowed is 6000. | **Notes** * Breaching the limits will reject the request. * Per-hour and per-day limits use a rolling window of the last 1 hour and last 24 hours respectively. ' tags: - Get Campaign Details parameters: - $ref: '#/components/parameters/MOE-APPKEY' - $ref: '#/components/parameters/X-MOE-Request-Id' - $ref: '#/components/parameters/Idempotency-Key-Required' requestBody: description: 'Provide the search criteria for retrieving campaign metadata and reachability information. ' required: true content: application/json: schema: $ref: '#/components/schemas/MetaV5Request' examples: filter_by_id_and_status: summary: Filter by ID and status value: request_id: '{{request_id}}' limit: 15 page: 1 campaign_fields: id: '{{campaign_id}}' status: - SCHEDULED - ACTIVE - PAUSED - DRAFT filter_by_channel_and_date: summary: Filter by channel and date range value: request_id: '{{request_id}}' limit: 15 page: 1 campaign_fields: channels: - PUSH - EMAIL created_date: from_date: '2024-01-01T00:00:00' to_date: '2024-12-31T23:59:59' filter_by_delivery_type_and_creator: summary: Filter by delivery type and creator value: request_id: '{{request_id}}' limit: 15 page: 1 campaign_fields: delivery_type: ONE_TIME created_by: - '{{creator_email}}' name: '{{campaign_name_partial}}' tags: - promotional include_child_campaigns: false with_child_counts: summary: With child campaign counts value: request_id: '{{request_id}}' limit: 15 page: 1 campaign_fields: channels: - PUSH - EMAIL campaign_delivery_type: - PERIODIC - BUSINESS_EVENT_TRIGGERED include_child_campaigns: true reachability: summary: Reachability for a scheduled campaign value: request_id: '{{request_id}}' limit: 1 page: 1 campaign_fields: id: '{{campaign_id}}' status: - SCHEDULED filter_sms_whatsapp: summary: Filter SMS and WhatsApp value: request_id: '{{request_id}}' limit: 15 page: 1 campaign_fields: channels: - SMS - WHATSAPP status: - ACTIVE responses: '200': description: Campaign meta rows content: application/json: schema: allOf: - $ref: '#/components/schemas/V5SuccessEnvelope' - type: object properties: data: $ref: '#/components/schemas/CampaignMetaListResponseData' examples: scheduled_push_with_reachability: summary: Scheduled Push campaign with reachability details value: response_id: resp-meta-001 type: campaign data: campaigns: - campaign_id: 64a1b2c3d4e5f6a7b8c9d0e1 channel: PUSH platform: - ANDROID - IOS created_by: marketer@example.com campaign_delivery_type: ONE_TIME campaign_name: Summer Sale Campaign campaign_team: Growth Team campaign_tags: - promotional - seasonal campaign_status: SCHEDULED campaign_start_time: '2024-11-28T12:18:00' reachability_details: count: 18182 last_updated_time: '2024-11-27T09:05:42.661000' periodic_with_child_campaigns: summary: Periodic campaign with child campaign counts value: response_id: resp-meta-002 type: campaign data: campaigns: - campaign_id: 64a1b2c3d4e5f6a7b8c9d0e2 channel: EMAIL platform: [] created_by: marketer@example.com campaign_delivery_type: PERIODIC campaign_name: Weekly Newsletter campaign_team: Retention Team campaign_tags: - newsletter campaign_status: ACTIVE campaign_start_time: '2024-01-01T08:00:00' total_child_campaigns: 12 reachability_details: null '400': description: Request failed schema or field validation. content: application/json: schema: $ref: '#/components/schemas/V5ErrorEnvelope' examples: missing_request_id: summary: Missing request_id value: response_id: resp-meta-400-a error: code: VALIDATION_FAILED message: One or more fields failed validation. request_id: '' details: - target: request_id message: request_id is required. missing_limit: summary: Missing limit value: response_id: resp-meta-400-b error: code: VALIDATION_FAILED message: One or more fields failed validation. request_id: '{{request_id}}' details: - target: limit message: limit is required. missing_page: summary: Missing page value: response_id: resp-meta-400-c error: code: VALIDATION_FAILED message: One or more fields failed validation. request_id: '{{request_id}}' details: - target: page message: page is required. feature_not_enabled: summary: Feature not enabled for workspace value: response_id: resp-meta-400-d error: code: VALIDATION_FAILED message: Campaign metadata API is not enabled for this workspace. request_id: '{{request_id}}' details: [] '401': $ref: '#/components/responses/V5Unauthorized' '500': $ref: '#/components/responses/V5InternalError' servers: - url: https://api-{dc}.moengage.com/ description: MoEngage Campaigns API Server variables: dc: default: '01' description: Data center (DC) segment in the hostname. Replace `OX` with your workspace DC (01–06 or 101). See [Data centers](/api/introduction#data-centers). /campaigns/search: post: operationId: search_campaigns summary: Search Campaigns description: 'This API fetches a list of Push, Email, or SMS campaigns with all current fields and status. You can pass multiple filters to find specific campaigns. ' x-mint: content: "\n#### Search Capabilities\n- Filter by channel, delivery type, status, tags, name, ID, created by, created date\n- Include child campaigns (flow nodes, periodic children)\n- Include archived campaigns\n- Paginated results (max 15 per page)\n\n\n**Differences in V5**\n\nThe V5 Search Campaigns API (`POST /v5/campaigns/search`) introduces the following behavioral changes:\n\n- **Single-campaign retrieval** is no longer handled by the search endpoint. Use `GET /v5/campaigns/{campaign_id}` instead.\n- The `campaign_fields.id` field (string) is renamed to `campaign_fields.ids` (array of strings) in V5.\n- The `campaign_fields.delivery_type` field is renamed to `campaign_fields.campaign_delivery_type` in V5. Sending the V1 field name returns zero results with no error.\n- `request_id` is required in V1. In V5, it is optional.\n- The response identifier field `campaign_id` is renamed to `id` in V5.\n\nFor a full comparison, see [V1 vs. V5 Search Campaigns: Behavioral Differences](/api/campaigns/search-campaigns-v5-migration).\n\n\n\n #### Rate Limits\n\n| Rate Limit Name | Rate Limit |\n| :--- | :--- |\n| Search campaign per second | The total number of search campaign requests per second per client allowed is 10. |\n| Search campaign per minute | The total number of search campaign requests per minute per client allowed is 100. |\n| Search campaign per hour | The total number of search campaign requests per hour per client allowed is 6000. | \n\n\n **Notes**\n * Breaching the limits will reject the request.\n * Per hour and per day limits will consider the calculation based on the last hour and last 24 hrs respectively.\n\n" tags: - Get Campaign Details parameters: - $ref: '#/components/parameters/MOE-APPKEY_2' requestBody: description: 'Provide the search criteria and pagination parameters for finding campaigns. ' required: true content: application/json: schema: $ref: '#/components/schemas/CampaignSearchRequest' examples: search_by_channel_email: summary: Search by Channel (Email) value: request_id: search_req_12345 campaign_fields: channels: - EMAIL limit: 15 page: 1 search_by_channel_push: summary: Search by Channel (Push) value: request_id: search_req_67890 campaign_fields: channels: - PUSH limit: 15 page: 1 search_by_channel_sms: summary: Search by Channel (SMS) value: request_id: search_req_sms campaign_fields: channels: - SMS limit: 15 page: 1 search_by_delivery_type: summary: Search by Delivery Type value: request_id: search_req_periodic campaign_fields: delivery_type: - PERIODIC limit: 15 page: 1 search_by_created_date: summary: Search by Created Date value: request_id: search_req_date campaign_fields: created_date: from_date: '2024-06-16' to_date: '2024-06-21' limit: 10 page: 1 search_by_campaign_name: summary: Search by Campaign Name value: request_id: search_req_name campaign_fields: name: Summer Sale Campaign limit: 5 page: 1 search_by_campaign_id: summary: Search by Campaign ID value: request_id: search_req_id campaign_fields: id: camp_abc123xyz limit: 1 page: 1 search_all_filters: summary: Search with Multiple Filters value: request_id: search_req_all campaign_fields: channels: - PUSH created_by: - john.doe@example.com created_date: from_date: '2024-01-01' to_date: '2024-12-31' delivery_type: - ONE_TIME status: - ACTIVE tags: - summer - sale include_child_campaigns: true include_archive_campaigns: false limit: 15 page: 1 responses: '200': description: Successfully retrieved campaign list content: application/json: schema: type: array items: $ref: '#/components/schemas/CampaignDetailsResponse_2' examples: email_campaign: summary: Email Campaign Response value: - campaign_id: camp_email_123 status: Active channel: EMAIL campaign_delivery_type: PERIODIC created_by: john.doe@example.com created_at: '2024-07-04 08:00:54.847000' sent_time: '2024-07-04 20:32:00' basic_details: name: Weekly Newsletter content_type: PROMOTIONAL subscription_category: marketing tags: - newsletter connector: connector_type: SENDGRID connector_name: default push_campaign: summary: Push Campaign Response value: - campaign_id: camp_push_456 status: Scheduled channel: PUSH campaign_delivery_type: ONE_TIME created_by: jane.smith@example.com created_at: '2025-06-26 12:09:20.209000' sent_time: '2025-06-26 12:47:00.196000' basic_details: name: Flash Sale Notification platforms: - ANDROID - IOS tags: - sale sms_campaign: summary: SMS Campaign Response value: - campaign_id: camp_sms_789 status: Active channel: SMS campaign_delivery_type: ONE_TIME created_by: admin@example.com created_at: '2024-05-20 06:04:50.505000' sent_time: '2024-05-20 06:04:50.505000' sender_name: MoEngage basic_details: name: Discount Code SMS tags: - discount '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalServerError' servers: - url: https://api-{dc}.moengage.com/core-services/v1 description: MoEngage Campaigns API Server variables: dc: default: '01' description: The ‘dc’ in the API Endpoint URL refers to the MoEngage Data Center (DC). MoEngage hosts each customer in a different DC. You can find your DC number and replace the value of ‘dc’ in the URL by referring to the DC and API endpoint mapping [here](/api/introduction#data-centers). Your MoEngage Data Center (DC) can be 01, 02, 03, 04, 05, 06, or 101. /campaigns/meta: post: operationId: get_campaign_meta summary: Get Campaign Meta (V1 — Legacy) description: 'This API retrieves campaign details and reachability information for scheduled campaigns. ' x-mint: content: "\n**V1 endpoint**\n\nThis page documents the V1 Get Campaign Meta endpoint. The V5 equivalent is available at [Get Campaign Meta (V5)](/api/get-campaign-details/get-campaign-meta). Both V1 and V5 use Basic Auth with a `MOE-APPKEY` header.\n\n\n#### Supported Channels\n- EMAIL: Email campaigns\n- PUSH: Push notification campaigns\n- SMS: SMS campaigns\n- WHATSAPP: WhatsApp campaigns\n- FACEBOOK: Facebook campaigns\n- GOOGLE ADS: Google Ads campaigns\n- CONNECTORS: Connector-based campaigns\n\n#### Reachability Information\n- Available only for **scheduled** campaigns (one-time, business event-triggered, and event-triggered).\n- Provides estimated user count that will receive the campaign.\n- Calculated once daily and cached for 24 hours.\n- May vary due to app installations/uninstalls or subscription changes.\n- Reachability is an estimated value and may vary over time. It is calculated once per day and cached for 24 hours. Multiple API calls within the same day will return the cached value.\n\n#### Rate Limits\n\n| Rate Limit Name | Rate Limit |\n| :--- | :--- |\n| get campaign meta per second | The total number of get campaign meta requests per Second per client allowed is 10. |\n| get campaign meta per minute | The total number of get campaign meta requests per minute per client allowed is 100. |\n| get campaign meta per hour | The total number of get campaign meta requests per hour per client allowed is 6000. | \n\n \n **Notes**\n * Breaching the limits will reject the request.\n * Per hour and per day limits will consider the calculation based on the last hour and last 24 hrs respectively.\n \n" tags: - Get Campaign Details parameters: - $ref: '#/components/parameters/MOE-APPKEY_2' requestBody: description: 'Provide the search criteria for retrieving campaign metadata and reachability information. ' required: true content: application/json: schema: $ref: '#/components/schemas/CampaignMetaRequest' examples: meta_by_channel: summary: Get Meta by Channel value: request_id: meta_req_12345 campaign_fields: channels: - EMAIL limit: 15 page: 1 meta_by_campaign_id: summary: Get Meta by Campaign ID value: request_id: meta_req_67890 campaign_fields: id: camp_abc123xyz limit: 1 page: 1 meta_scheduled_with_reachability: summary: Get Scheduled Campaign with Reachability value: request_id: meta_req_scheduled campaign_fields: channels: - SMS status: - SCHEDULED limit: 10 page: 1 meta_with_child_campaigns: summary: Get Meta with Child Campaigns value: request_id: meta_req_children campaign_fields: delivery_type: - PERIODIC include_child_campaigns: true limit: 15 page: 1 responses: '200': description: Successfully retrieved campaign metadata content: application/json: schema: type: array items: $ref: '#/components/schemas/CampaignMetaResponse' examples: email_campaign_meta: summary: Email Campaign Meta value: - campaign_id: camp_email_123 channel: EMAIL platform: [] created_by: john.doe@example.com campaign_delivery_type: ONE_TIME campaign_name: Weekly Newsletter campaign_team: Marketing campaign_tags: - newsletter - weekly campaign_status: Active campaign_start_time: '2024-11-18T05:50:00' sms_scheduled_with_reachability: summary: SMS Scheduled with Reachability value: - campaign_id: camp_sms_456 channel: SMS platform: [] created_by: admin@example.com campaign_delivery_type: ONE_TIME campaign_name: Promo Code SMS campaign_team: Sales campaign_tags: - promo campaign_status: Scheduled campaign_start_time: '2024-11-28T12:18:00' reachability_details: count: 18182 last_updated_time: '2024-11-27T09:05:42.661000' push_campaign_meta: summary: Push Campaign Meta value: - campaign_id: camp_push_789 channel: PUSH platform: - ANDROID - IOS created_by: jane.smith@example.com campaign_delivery_type: EVENT_TRIGGERED campaign_name: Cart Abandonment campaign_team: Retention campaign_tags: - cart - abandonment campaign_status: Active campaign_start_time: '2024-11-20T10:00:00' periodic_with_children: summary: Periodic Campaign with Children value: - campaign_id: camp_periodic_101 channel: EMAIL platform: [] created_by: marketing@example.com campaign_delivery_type: PERIODIC campaign_name: Monthly Newsletter campaign_team: Content campaign_tags: - newsletter campaign_status: Active campaign_start_time: '2024-01-01T09:00:00' total_child_campaigns: 12 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalServerError' servers: - url: https://api-{dc}.moengage.com/core-services/v1 description: MoEngage Campaigns API Server variables: dc: default: '01' description: The ‘dc’ in the API Endpoint URL refers to the MoEngage Data Center (DC). MoEngage hosts each customer in a different DC. You can find your DC number and replace the value of ‘dc’ in the URL by referring to the DC and API endpoint mapping [here](/api/introduction#data-centers). Your MoEngage Data Center (DC) can be 01, 02, 03, 04, 05, 06, or 101. /campaigns/{parent_campaign_id}/executions: post: operationId: get_child_campaigns summary: Get Child Campaigns description: 'This API retrieves child campaign execution details for Periodic or Business Event-triggered campaigns. Use this API to track execution history of recurring campaigns and monitor the performance of individual instances. ' x-mint: content: "\n**Not available in V5**\n\nThis endpoint is not yet available in V5. Use this V1 endpoint at `POST /core-services/v1/campaigns/{parent_campaign_id}/executions` until V5 support is added.\n\n\n#### Information Retrieved\n- Child campaign IDs\n- Sent time for each execution\n- Status of each child campaign\n- Total number of times the parent campaign has been executed\n\n\n**Note**\n- Currently, you can use this API to get the child of Periodic and Business Event-triggered Email and Push campaigns.\n- You can only retrieve child campaigns for campaigns created via the [Create Campaign API](https://www.moengage.com/docs/api/create-campaigns/create-campaign).\n- Results are paginated with a maximum of 15 children per page.\n\n\n#### Rate Limits\n\n| Rate Limit Name | Rate Limit |\n| :--- | :--- |\n| get child campaign per second | The total number of get child campaigns requests per second per client allowed is 10. |\n| get child campaign per minute | The total number of get child campaigns requests per minute per client allowed is 100. |\n| get child campaign per hour | The total number of get child campaigns requests per hour per client allowed is 6000. | \n\n\n **Notes**\n * Breaching the limits will reject the request.\n * Per hour and per day limits will consider the calculation based on the last hour and last 24 hrs respectively.\n\n" tags: - Get Campaign Details parameters: - name: parent_campaign_id in: path required: true description: 'The unique ID of the parent campaign (Periodic or Business Event-triggered). You can fetch the parent campaign ID using the Search Campaigns API. ' schema: type: string example: camp_periodic_parent_123 - $ref: '#/components/parameters/MOE-APPKEY_2' requestBody: description: Provide pagination parameters for retrieving child campaign executions. required: true content: application/json: schema: $ref: '#/components/schemas/GetChildCampaignsRequest' examples: get_periodic_children: summary: Get Periodic Campaign Children value: request_id: child_req_12345 page: 1 limit: 15 get_business_event_children: summary: Get Business Event Children value: request_id: child_req_67890 page: 1 limit: 10 get_second_page: summary: Get Second Page of Children value: request_id: child_req_page2 page: 2 limit: 15 responses: '200': description: Successfully retrieved child campaign execution details content: application/json: schema: $ref: '#/components/schemas/ChildCampaignsResponse' examples: periodic_executions: summary: Periodic Campaign Executions value: executions: - campaign_id: camp_child_001 sent_time: '2024-06-24T14:30:18.908000' status: Sent - campaign_id: camp_child_002 sent_time: '2024-06-24T15:27:45.971000' status: Sent - campaign_id: camp_child_003 sent_time: '2024-06-24T15:47:43.528000' status: Sent - campaign_id: camp_child_004 sent_time: '2024-06-24T15:54:26.254000' status: Sent - campaign_id: camp_child_005 sent_time: '2024-06-24T16:35:01.834000' status: Sending total_instances: 8 '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalServerError' servers: - url: https://api-{dc}.moengage.com/core-services/v1 description: MoEngage Campaigns API Server variables: dc: default: '01' description: The ‘dc’ in the API Endpoint URL refers to the MoEngage Data Center (DC). MoEngage hosts each customer in a different DC. You can find your DC number and replace the value of ‘dc’ in the URL by referring to the DC and API endpoint mapping [here](/api/introduction#data-centers). Your MoEngage Data Center (DC) can be 01, 02, 03, 04, 05, 06, or 101. components: schemas: EmailCampaignContent: type: object description: 'Email content, locales, and A/B variations. For full `POST /v5/campaigns` request examples that include `campaign_content`, refer to `campaign_delivery_type` on `EmailCampaignCreateV5Request`, `VariationDetails`, and the Create Campaign Draft code samples. For Email content variants, including `html_content` versus `custom_template_id`, CC/BCC, attachments, and editor selection (`Froala Editor` versus `Ace Editor`), refer to [Email content](/api/campaigns/campaign-content-reference#email-content). ' properties: locales: type: array items: type: string description: 'Additional locale names for multi-language campaigns. List only the non-default locales here (for example, `"en-US"`, `"es-ES"`). The `"default"` locale is always implicitly present and must not be included in this array. ' example: - en-US - es-ES variation_details: $ref: '#/components/schemas/VariationDetails' content: type: object description: 'The campaign message payload. Two shapes are accepted: - **Flat shape (no locales or variations):** Pass a flat `email` object directly under `content`. - **Locale-keyed and variation-keyed shape:** Key by locale name, then by variation name: `content[locale_name][variation_name] = { email: { ... } }`. The `"default"` locale key is always required and serves as the fallback. Additional locale keys must match values listed in `locales`. For runnable payloads for both shapes, refer to [Content payload structure](/api/campaigns/campaign-content-reference#content-payload-structure). ' properties: email: $ref: '#/components/schemas/EmailContent' additionalProperties: type: object description: Variation-keyed content blocks for a single locale. additionalProperties: type: object properties: email: $ref: '#/components/schemas/EmailContent' GoalEventAttribute: type: object description: Attributes associated with the conversion goal event. properties: name: type: string description: The name of the goal event attribute. condition: type: string description: The condition used while creating the goal (e.g., "is", "contains", "between"). data_type: type: string enum: - STRING - DOUBLE - BOOL - NUMBER - GEOPOINT - DATETIME - ARRAY_DOUBLE - ARRAY_STRING - OBJECT - ARRAY_OBJECT description: The data type of the attribute. value: type: string description: 'The value of the goal event attribute. Supported data types: STRING, DOUBLE, BOOL, NUMBER, GEOPOINT, DATETIME, ARRAY_DOUBLE, ARRAY_STRING. ' value1: type: string description: 'A secondary value, used for conditions like ''between''. Supported data types: STRING, DOUBLE, BOOL, NUMBER, GEOPOINT, DATETIME, ARRAY_DOUBLE, ARRAY_STRING. ' negate: type: boolean description: Whether to negate the filter condition. value_type: type: string description: The type of value being filtered. array_filter_type: type: string description: The logical filter type for array attributes. filters: type: array items: type: object description: A list of sub-filters used when data_type is OBJECT or ARRAY_OBJECT. is_case_sensitive: type: boolean description: Whether the goal event attribute is case-sensitive. KeyValuePair: type: object description: A custom key-value pair attached to the push payload. properties: key: type: string description: The key name. value: type: string description: The value. V5SuccessEnvelope: type: object properties: response_id: type: string type: type: string example: campaign data: type: object Geofences: type: object description: 'Geofence location details for location-triggered campaigns. **Required** for LOCATION_TRIGGERED campaigns. For per-`triggered_at` runnable payloads (`ENTRY`, `EXIT`, `dwell`) and the casing distinction between `ENTRY`/`EXIT` (uppercase) and `dwell` (lowercase), refer to [Geofence targeting](/api/campaigns/audience-scheduling-delivery-reference#geofence-targeting). ' required: - name - latitude - longitude - radius - response_time_value - response_time_granularity - triggered_at properties: name: type: string description: The unique name of the geofence location being targeted. latitude: type: string description: The latitude coordinate for the center of the geofence area. longitude: type: string description: The longitude coordinate for the center of the geofence area. radius: type: string description: The radius in meters from the center point that defines the boundary of the geofence. dwell_time_value: type: string description: 'The numeric value for the time to wait before sending the message after the trigger condition is met. **Required** when triggered_at is set to "dwell". ' dwell_time_granularity: type: string enum: - MINUTES - HOURS - DAYS description: 'The time unit for the dwell_time_value. **Required** when triggered_at is set to "dwell". ' response_time_value: type: string description: The numeric value for the time to wait before sending the message after the trigger condition is met. response_time_granularity: type: string enum: - MINUTES - HOURS - DAYS description: The time unit for the response_time_value. triggered_at: type: string enum: - ENTRY - EXIT - dwell description: 'The user action that triggers the campaign (when user enters/exits the geofence). ' AndroidTimer: type: object description: 'Timer configuration for Timer and Timer with Progress Bar templates. **Required for:** TIMER and TIMER_WITH_PROGRESS_BAR templates ' properties: timer_ends_at: type: string enum: - DURATION - SPECIFIC_TIME_USER_TIMEZONE - SPECIFIC_TIME_CAMPAIGN_TIMEZONE description: How the timer's endpoint is determined. specific_time: type: string format: date-time description: 'The specific time when the timer ends. **Required** when personalized_value is true. ' time_period: type: string description: 'The time period for the timer. **Required** when timer_ends_at is SPECIFIC_TIME_USER_TIMEZONE or SPECIFIC_TIME_CAMPAIGN_TIMEZONE. ' personalized_value: type: boolean description: 'Whether the timer duration is personalized per user. If false, all users get the same duration. ' duration_hour: type: string description: 'The number of hours the timer will run for. **Required** when personalized_value is false. ' example: '2' duration_minute: type: string description: 'The number of minutes the timer will run for (in addition to hours). **Required** when personalized_value is false. ' example: '30' AndroidTemplateBackup: type: object description: 'Fallback notification content for when the template cannot be rendered. **Required for:** Stylized Basic, Simple Image Carousel, Image Banner with Text, Timer, and Timer with Progress Bar templates ' properties: title: type: string description: The title for the fallback notification. message: type: string description: The message body for the fallback notification. summary: type: string description: The summary for the fallback notification. image_url: type: string format: uri description: The URL of an image for the fallback notification. default_click_action: type: string enum: - DEEPLINKING - NAVIGATE_TO_A_SCREEN - RICH_LANDING description: The default click action for the fallback notification. default_click_action_value: type: string description: The URL or deep link for the fallback's click action. key_value_pairs: type: array items: $ref: '#/components/schemas/KeyValuePair' description: Custom key-value pairs specific to the fallback payload. ConversionGoalDetails: type: object description: 'Configuration for tracking campaign conversion goals. For runnable single-goal and multi-goal examples, refer to [Conversion goal tracking](/api/campaigns/audience-scheduling-delivery-reference#conversion-goal-tracking). ' properties: attribution_window_in_hours: type: integer description: The attribution window in hours. example: 36 goals: type: array items: $ref: '#/components/schemas/Goal' description: List of conversion goals to track. AdvancedDetails: type: object description: 'Advanced Push delivery settings, including notification expiration and per-platform priority. For runnable iOS APNS priority and Android priority examples, refer to [Advanced Push settings](/api/campaigns/audience-scheduling-delivery-reference#advanced-push-settings). ' properties: expiration_settings: type: object properties: expire_notification_after_value: type: integer description: The numeric value for the notification expiration time. expire_notification_after_type: type: string enum: - HOUR - DAY description: The time unit for notification expiration. remove_from_inbox_after_value: type: integer description: The numeric value for when to remove the message from the inbox. remove_from_inbox_after_type: type: string enum: - DAY description: The time unit for removing the message from the inbox. platform_level_priority: type: object properties: android_specific_priority: type: object properties: send_with_priority: type: boolean description: Whether to send with priority. ios_specific_priority: type: object properties: apns_priority: type: string enum: - '1' - '5' - '10' description: The priority of notification delivery for APNS. interruption_level: type: string enum: - PASSIVE - ACTIVE - TIME_SENSITIVE - CRITICAL description: The interruption level for iOS notifications. relevance_score: type: number enum: - 0 - 0.5 - 1 description: The relevance score for iOS notifications. PushDeliveryControls: type: object description: 'Controls for Push campaign delivery behavior. For per-delivery-type runnable examples (throttle, event-triggered, device-triggered, location-triggered, queuing), refer to [Push delivery controls](/api/campaigns/audience-scheduling-delivery-reference#push-delivery-controls). ' properties: bypass_dnd: type: boolean description: 'Whether to bypass Do Not Disturb settings. Required for event-triggered campaigns. ' campaign_throttle_rpm: type: integer description: 'The campaign throttle in requests per minute. Not applicable for device-triggered, location-triggered, and event-triggered campaigns. ' example: 50000 count_for_frequency_capping: type: boolean description: Whether to count this campaign for frequency capping. ignore_frequency_capping: type: boolean description: Whether to ignore frequency capping for this campaign. minimum_delay_between_two_notification_in_hour: type: integer description: 'Minimum delay between two notifications in hours. Applies to event-triggered and device-triggered campaigns. ' max_time_to_show_message_of_same_camapign: type: string description: 'Maximum duration (in hours) that a message from this campaign will be displayed to a user. Applicable for device-triggered campaigns. ' expiry_time_of_sync_data_in_hour: type: string description: 'Duration (in hours) after which synced campaign data will expire if trigger condition is not met. Applicable for device-triggered campaigns. ' send_message_in_offline_mode: type: boolean description: 'Whether to store and deliver the message when the device is offline. Applicable for device-triggered campaigns. ' send_limit_value: type: string description: 'Maximum number of times a user can receive this campaign within the specified time granularity. Applicable for location-triggered campaigns. ' send_limit_granularity_in_hours: type: string description: 'Time window (in hours) during which the send_limit_value is enforced. Applicable for location-triggered campaigns. ' ignore_global_minimum_delay: type: boolean description: 'Whether to bypass the global minimum delay setting configured at the workspace level. When `true`, this campaign ignores the workspace-wide minimum interval between push notifications and can be delivered to a user regardless of how recently they received another push. Use this for time-sensitive campaigns (for example, transactional or alert-style messages) where respecting the global delay would reduce delivery timeliness. Applies to event-triggered campaigns. ' queuing_enabled: type: boolean description: 'Enables message queuing for this campaign. When set to `true`, messages that are temporarily blocked by DND, frequency capping, or minimum delay restrictions are held in a queue and delivered as soon as the restriction clears, rather than being dropped. **Supported delivery types:** `ONE_TIME`, `PERIODIC`, `EVENT_TRIGGERED`, `BUSINESS_EVENT_TRIGGERED`. Not applicable to `DEVICE_TRIGGERED` or `LOCATION_TRIGGERED` campaigns. **DND interaction:** - When `bypass_dnd` is `false` (DND respected): messages blocked during a DND window are queued and delivered once the window passes. - When `bypass_dnd` is `true` (DND ignored): queuing applies to frequency capping and minimum delay blocks only. **Auto-disabled:** When both `ignore_frequency_capping` and `minimum_delay_between_two_notification_in_hour` are configured to bypass all delivery restrictions, queuing is automatically disabled. **Queue limits:** Up to 10,000,000 messages for `ONE_TIME`, `PERIODIC`, and `BUSINESS_EVENT_TRIGGERED` campaigns; up to 1,000,000 for `EVENT_TRIGGERED` campaigns. **Delivery order:** Queued messages are delivered in first-in, first-out (FIFO) order. ' queue_duration: type: integer minimum: 0 maximum: 48 description: 'The duration in hours during which a queued message will be retried for delivery. Accepted range: `1`–`48` hours. Set to `0` when `queuing_enabled` is `false`. If a user does not become eligible for delivery within the configured window, the message is dropped and the outcome is recorded in campaign analytics. For active `PERIODIC` and triggered campaigns, changes to this value apply only to messages queued after the update. Messages already in the queue retain the original duration. ' SegmentationDetails: type: object description: 'Defines the target audience for the campaign. For included/excluded filter combinations, filter primitives (`user_attributes`, `actions`, `custom_segments`), and opt-out targeting, refer to [Campaign audience](/api/campaigns/audience-scheduling-delivery-reference#campaign-audience). ' properties: included_filters: $ref: '#/components/schemas/FilterGroup' excluded_filters: allOf: - $ref: '#/components/schemas/FilterGroup' description: 'Filters that exclude users from the campaign audience. ' is_all_user_campaign: type: boolean description: Whether to include all users in the campaign. send_campaign_to_opt_out_users: type: boolean description: Whether to send the campaign to users who have opted out. For runnable examples, refer to [Campaign audience](/api/campaigns/audience-scheduling-delivery-reference#campaign-audience). PeriodicDetails: type: object description: 'Configuration for periodic campaigns. **Required** for PERIODIC campaigns. For runnable Daily, Weekly, Monthly (specific dates), and Monthly (first Monday) examples, refer to [Periodic schedules](/api/campaigns/audience-scheduling-delivery-reference#periodic-schedules). ' properties: sending_frequency: type: string enum: - DAILY - WEEKLY - MONTHLY description: The frequency to send the campaign. repeat_frequency: type: integer description: The repeat frequency of the campaign. no_of_occurences: type: integer description: The number of occurrences of the campaign. repeat_on_date_of_month: type: array items: type: integer description: 'The dates of the month on which the campaign should be repeated. Example: [5, 25] to send on the 5th and 25th of each month. ' repeat_on_days_of_week: type: array items: type: string enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY description: 'The days of the week on which the campaign should repeat. ' repeat_on_days_of_week_for_month: type: array items: type: object properties: week_granularity: type: string enum: - FIRST - SECOND - THIRD - FOURTH - LAST repeat_on_days_of_week: type: array items: type: string enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY description: 'Configuration for repeating on specific weeks of the month. ' ControlGroupDetails: type: object description: 'Configuration for control groups. For runnable campaign-control-group and global-control-group examples, refer to [Control groups](/api/campaigns/audience-scheduling-delivery-reference#control-groups). ' properties: is_campaign_control_group_enabled: type: boolean description: Whether the campaign control group is enabled. campaign_control_group_percentage: type: integer minimum: 0 maximum: 100 description: 'The percentage of users added to the exclusion list. **Required** if is_campaign_control_group_enabled is true. ' is_global_control_group_enabled: type: boolean description: 'Whether the global control group is enabled. ' UserAttributeFilter: type: object title: User attributes-based filters description: Filter based on user attributes. properties: filter_type: type: string enum: - user_attributes data_type: type: string enum: - string - double - datetime - bool description: The data type of the attribute being filtered. category: type: string description: The category of the attribute (e.g., "Tracked Standard Attribute"). name: type: string description: The name of the attribute to filter on (e.g., "uid"). operator: type: string description: 'The operator to use in the filter. Allowed values depend on data_type: - bool: is, exists - double: in, between, lessThan, greaterThan, exists - string: in, contains, containsInTheFollowing, startWithInTheFollowing, endsWithInTheFollowing, exists, is - datetime: inTheLast, on, between, before, after, inTheNext, exists, today ' value: description: The value to filter on (not required for 'exists' operator). case_sensitive: type: boolean description: Whether the filter comparison should be case-sensitive. negate: type: boolean description: Whether to negate the filter condition. is_dynamic_value: type: boolean description: 'When `true`, the filter value is treated as a dynamic expression and resolved at send time rather than evaluated as a literal string. Set this to `true` for Business Event-triggered campaigns where the filter value references a Business Event attribute, for example, `{{BusinessEventAttribute[''season'']}}`. ' project_name: type: string description: 'The name of the project associated with the user attributes. **Required** if the Portfolio feature is enabled in your workspace. ' PushBasicDetailsV5: type: object description: 'Identifying metadata for the Push campaign, including name, team, tags, and platform targeting. For field-by-field rules, conditional requirements, and platform-specific delivery flags (Android `push_amp_plus_enabled`, iOS provisional-push audience flags), refer to [Push campaign metadata](/api/campaigns/campaign-content-reference#push-campaign-metadata). ' properties: name: type: string description: The name of the campaign. example: Summer Sale Push Notification business_event: type: string description: 'The business event to be mapped to the campaign. **Required** for BUSINESS_EVENT_TRIGGERED campaigns. ' example: user_signup tags: type: array items: type: string description: Tags that provide context about the campaign's nature or theme. example: - activation - summer_sale team: type: string description: 'The name of the team collaborating on this campaign. For more information, refer to [Teams in MoEngage](https://help.moengage.com/hc/en-us/articles/360028586211-Teams-in-MoEngage). ' example: marketing_team platforms: type: array items: type: string enum: - ANDROID - IOS - WEB description: The platforms to target for this Push campaign. example: - ANDROID - IOS broadcast_live_activity_id: type: string description: 'The broadcast live activity ID for iOS Live Activities. **Required** when platform is iOS and delivery_type is BROADCAST_LIVE_ACTIVITY. **Not applicable in the draft-based creation flow.** `BROADCAST_LIVE_ACTIVITY` is not supported via POST `/v5/campaigns`. ' example: live_check123 geofences: $ref: '#/components/schemas/Geofences' send_to_triggered_platform_only: type: boolean description: Whether to send the campaign only to the platform that triggered the event. Applicable for event-triggered campaigns. platform_specific_details: $ref: '#/components/schemas/PlatformSpecificDetails' CampaignSearchResponseData: type: object required: - campaigns description: Search and meta list endpoints wrap rows under `data.campaigns`. properties: campaigns: type: array items: $ref: '#/components/schemas/CampaignDetailsResponse' BTSDetails: type: object description: '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-when-`SEND_IN_BTS` rule, refer to [Best Time to Send](/api/campaigns/audience-scheduling-delivery-reference#best-time-to-send). ' properties: send_in_bts: type: boolean description: Whether to send the campaign at the best time. if_user_bts_is_not_available: type: string description: When to send the campaign if the user's best time is not available. if_user_bts_outside_time_window: type: string description: When to send the campaign if the user's best time is outside the time window. window_end_time: type: string description: The window end time. example: 6:43 am UTMParams: type: object description: 'UTM parameters for tracking campaign performance. The five standard keys (`utm_source`, `utm_medium`, `utm_campaign`, `utm_term`, `utm_content`) are explicitly defined. **Custom UTM parameters:** Up to 5 additional custom parameters can be passed as separate keys directly inside the `utm_params` object. Custom keys accept arbitrary names — the `utm_` prefix is a convention, not a requirement (for example, `utm_cust` or `campaign_source` are both accepted). For runnable examples, refer to [UTM parameters](/api/campaigns/audience-scheduling-delivery-reference#utm-parameters). ' properties: utm_source: type: string description: 'The source of the traffic (for example, YouTube, Instagram, Google). **Required** when using UTM parameters. ' example: '{{utm_source}}' utm_medium: type: string description: 'The channel type (for example, Push, SMS, Email). **Required** when using UTM parameters. ' example: '{{utm_medium}}' utm_campaign: type: string description: The name of the campaign (for example, Newyear, Bigbillionday). example: '{{utm_campaign}}' utm_term: type: string description: Search terms for paid traffic (for example, Mobile+sale). utm_content: type: string description: The content element that differentiates links (for example, banner, video). utm_custom: type: string description: 'A single custom UTM parameter value. For multiple custom parameters, pass them as separate top-level keys inside the `utm_params` object using arbitrary `utm_`-prefixed names (for example, `utm_cust`, `utm_c1ust`, `utm_c2ust`). A maximum of 5 custom parameters is supported in total. ' additionalProperties: type: string description: 'Arbitrary custom UTM parameters with `utm_`-prefixed key names (for example, `utm_cust`, `utm_c1ust`). Up to 5 custom parameters are supported in total across all custom keys. ' AndroidPushContent: type: object description: Android push notification content. properties: template_type: type: string enum: - BASIC - STYLIZED_BASIC - SIMPLE_IMAGE_CAROUSEL - IMAGE_BANNER_WITH_TEXT - TIMER - TIMER_WITH_PROGRESS_BAR - Custom description: 'The type of Android push template. **Note:** If you are passing a template ID, set template_type to "Custom" and use `custom_template_id`. ' custom_template_id: type: string description: 'The ID of the custom template. **Required** when template_type is "Custom". ' custom_template_version: type: integer description: The version of the custom template. basic_details: $ref: '#/components/schemas/AndroidBasicDetails' timer: $ref: '#/components/schemas/AndroidTimer' buttons: type: array items: $ref: '#/components/schemas/AndroidButton' description: Action buttons for the notification. advanced: $ref: '#/components/schemas/AndroidAdvanced' template_backup: $ref: '#/components/schemas/AndroidTemplateBackup' IOSButton: type: object description: Action button configuration for iOS push notifications. properties: button_category: type: string description: 'The pre-defined category name for a set of interactive buttons configured in the app. ' example: MOE_PUSH_TEMPLATE PushTriggerCondition: type: object description: 'Trigger condition details for Push event-triggered, device-triggered, and related campaigns. **Required** for `EVENT_TRIGGERED`, `DEVICE_TRIGGERED`, and `LOCATION_TRIGGERED` Push campaigns. For per-delay-type runnable payloads (`ASAP`, `DELAY` with `AFTER`/`BEFORE`, `INTELLIGENT_DELAY`), filter primitives, and primary/secondary filter combinations, refer to [Trigger conditions](/api/campaigns/audience-scheduling-delivery-reference#trigger-conditions). ' properties: included_filters: $ref: '#/components/schemas/FilterGroup' secondary_included_filters: allOf: - $ref: '#/components/schemas/FilterGroup' description: Additional filters that must also be satisfied for the trigger to fire. For runnable examples, refer to [Primary and secondary trigger filters](/api/campaigns/audience-scheduling-delivery-reference#primary-and-secondary-trigger-filters). trigger_delay_type: type: string enum: - DELAY - ASAP - INTELLIGENT_DELAY description: 'The type of triggered delay. When set to DELAY, the following fields are mandatory: - trigger_delay_value - trigger_delay_granularity - trigger_relation ' trigger_delay_value: type: integer minimum: 0 description: The numeric value of the triggered delay. trigger_delay_granularity: type: string enum: - MINUTES - HOURS - DAYS description: The time unit for the trigger delay. trigger_relation: type: string enum: - BEFORE - AFTER description: 'The trigger relation with delay. **Required** when trigger_delay_type is DELAY. ' trigger_attr: type: string description: The attribute value of the trigger. Pass the string `"If Action"` for event-triggered campaigns. intelligent_delay_optimization: type: object description: 'Configuration for intelligent delay optimization. Used when trigger_delay_type is INTELLIGENT_DELAY. Defines a time window (min/max delay) within which the system finds the optimal moment to send the message. ' properties: min_delay_value: type: integer description: The numeric component of the lower bound for the intelligent delay window. min_delay_granularity: type: string enum: - MINUTES - HOURS description: The time unit that qualifies the min_delay_value. max_delay_value: type: integer description: The numeric component of the upper bound for the intelligent delay window. max_delay_granularity: type: string enum: - HOURS - DAYS description: The time unit that qualifies the max_delay_value. IOSAdvanced: type: object description: Platform-level advanced settings for push delivery - TTL, priority, badge count, and similar controls. properties: coupon_code: type: string description: The coupon code to be included in the push payload. sound_file: type: string description: The name of a custom sound file located in the app bundle to play upon receiving the notification. enable_ios_badge: type: boolean description: Whether this campaign allows the notification to increment the app's badge count. group_key: type: string description: 'The group key used to identify and categorize related push notifications. **Note:** - Use the same group key for all push notifications you want to group - MoEngage automatically modifies the group key to ensure it doesn''t exceed 45 characters - Non-Latin scripts, special characters, and spaces are removed ' collapse_replace_key: type: string description: 'The update key used to identify and update related push notifications. Ensure you use the same update key for all push notifications intended to update each other. ' CustomSegmentFilter: type: object title: Custom segments description: Filter using a custom segment. properties: filter_type: type: string enum: - custom_segments name: type: string description: The name of the custom segment. id: type: string description: The ID of the custom segment. WebBasicDetails: type: object description: Basic details for the Web push notification. properties: title: type: string description: The title text displayed at the top of the notification. example: Special Offer message: type: string description: The main body text of the notification. example: Check out our latest deals! redirect_url: type: string format: uri description: The URL that the user is redirected to when they click the main body of the notification. example: https://example.com/offers image_url: type: string format: uri description: The URL of a large image to be displayed within the notification content. auto_dismiss_notification: type: boolean description: Whether the notification should auto-dismiss. IOSPushContent: type: object description: iOS push notification content. properties: template_type: type: string enum: - BASIC - STYLIZED_BASIC - SIMPLE_IMAGE_CAROUSEL - Custom description: 'The type of iOS push template. ' custom_template_id: type: string description: 'The ID of the custom template. **Required** when template_type is "Custom". ' custom_template_version: type: integer description: The version of the custom template. basic_details: $ref: '#/components/schemas/IOSBasicDetails' buttons: type: array items: $ref: '#/components/schemas/IOSButton' description: Action buttons for the notification. advanced: $ref: '#/components/schemas/IOSAdvanced' template_backup: $ref: '#/components/schemas/IOSTemplateBackup' AndroidButton: type: object description: Action button configuration for Android push notifications. properties: btn_name: type: string description: The text to be displayed on the button. example: Shop Now click_action_type: type: string enum: - DEEPLINKING - NAVIGATE_TO_A_SCREEN - RICH_LANDING - CALL - SHARE - COPY - SET_USER_ATTRIBUTE - TRACK_EVENT - CUSTOM_ACTION - SNOOZE - REMIND_LATER description: The type of action to perform when the button is clicked. click_action_name: type: string description: The name of the click action. click_action_value: type: string description: The URL or deep link to open for the button's action. example: https://example.com/product key_value_pairs: type: array items: $ref: '#/components/schemas/KeyValuePair' description: Custom key-value pairs specific to this button's click event. CampaignMetaResponseV5: type: object description: 'Campaign metadata including basic information and reachability details. **V1 compatibility:** - All field names are preserved from the V1 Get Campaign Meta response: `campaign_id`, `campaign_name`, `campaign_status`, `campaign_delivery_type`, `campaign_team`, `campaign_tags`, `campaign_start_time`. - No field has been renamed in V5. - V5 adds one new field: `version_number` (present only when campaign versioning is enabled). ' properties: campaign_id: type: string description: The unique ID of the campaign. example: camp_abc123xyz version_number: type: integer description: 'Monotonic version index for this campaign document when campaign versioning is enabled. `campaign_id` is the canonical identifier across versions. ' channel: type: string enum: - EMAIL - PUSH - SMS - WHATSAPP - FACEBOOK - GOOGLE ADS - CONNECTORS description: The communication channel. platform: type: array items: type: string enum: - ANDROID - IOS - WEB description: The platform types supported for the campaign (applicable for Push). created_by: type: string format: email description: The email ID of the user who created the campaign. campaign_delivery_type: type: string enum: - ONE_TIME - PERIODIC - EVENT_TRIGGERED - BUSINESS_EVENT_TRIGGERED - DEVICE_TRIGGERED - LOCATION_TRIGGERED - BROADCAST_LIVE_ACTIVITY description: The delivery type of the campaign. campaign_name: type: string description: The name of the campaign. example: Summer Sale Campaign campaign_team: type: string description: The team name associated with the campaign. campaign_tags: type: array items: type: string description: Tags associated with the campaign. campaign_status: type: string enum: - DRAFT - SCHEDULED - ACTIVE - PAUSED - SENT - SENDING - STOPPED - ARCHIVED description: The current status of the campaign. campaign_start_time: type: string format: date-time description: The start time of the campaign in ISO 8601 format. This value is returned in UTC. example: '2024-11-28T12:18:00' parent_campaign_id: type: string description: 'The `id` (24-character ObjectId) of the parent campaign. Only shown if the requested `id` belongs to a child campaign and `include_child_campaigns` is true. ' total_child_campaigns: type: integer description: 'The number of child campaigns. Only shown if the campaign_id belongs to a parent campaign. Only applicable for periodic campaigns. ' rejection_comment: type: string description: 'The reason a campaign was rejected during review. Only present when the campaign''s current status is `DRAFT` after a rejection. ' reachability_details: type: - object - 'null' description: 'Reachability information for the campaign. **Availability:** Only populated for **scheduled** campaigns of these delivery types: - One-time scheduled campaigns - Business event-triggered campaigns - Event-triggered campaigns For all other campaign types (periodic, device-triggered, location-triggered, etc.), this field is `null`. Reachability is an estimated value calculated once daily and cached for 24 hours. Multiple API calls within the same day return the cached value. The count may vary over time as users install or uninstall the app, or change their subscription status. ' properties: count: type: integer description: The estimated number of users the scheduled campaign will reach. example: 18182 last_updated_time: type: string format: date-time description: The timestamp when reachability was last calculated, in ISO 8601 format. This value is returned in UTC. example: '2024-11-27T09:05:42.661000' IOSTemplateBackup: type: object description: 'Fallback notification content for when the template cannot be rendered. **Required for:** Stylized Basic and Simple Image Carousel templates ' properties: title: type: string description: The title for the fallback notification. message: type: string description: The message body for the fallback notification. subtitle: type: string description: The subtitle for the fallback notification. allow_bg_refresh: type: boolean description: Whether to enable background app refresh for the fallback notification. rich_media_type: type: string enum: - Image - Video - GIF description: The type of media attachment for the fallback. rich_media_value: type: string format: uri description: The URL of the media attachment for the fallback. default_click_action: type: string enum: - DEEPLINKING - NAVIGATE_TO_A_SCREEN - RICH_LANDING description: The default click action for the fallback notification. default_click_action_value: type: string description: The URL or deep link for the fallback's click action. key_value_pairs: type: array items: $ref: '#/components/schemas/KeyValuePair' description: Custom key-value pairs specific to the fallback payload. CampaignMetaListResponseData: type: object description: 'The response does not include a `total_count` field. To determine whether you have reached the last page, check whether the number of items returned is less than the `limit` you requested. If `campaigns` contains fewer items than `limit`, you have retrieved all results. ' required: - campaigns properties: campaigns: type: array items: $ref: '#/components/schemas/CampaignMetaResponseV5' V5ErrorEnvelope: type: object properties: response_id: type: string error: type: object properties: code: type: string enum: - VALIDATION_FAILED - UNPROCESSABLE_ENTITY - BAD_REQUEST - RATE_LIMITED - UNAUTHORIZED - INTERNAL_ERROR - FORBIDDEN message: type: string target: type: string details: type: array items: type: object properties: target: type: string message: type: string request_id: type: string description: 'The `request_id` from the originating request. Use this to correlate a failed response back to the specific call that triggered it, particularly useful in high-volume or retry scenarios. In V1, `request_id` appeared inside the `error` object. V5 preserves this field in the same location. ' SearchV5Request: type: object required: - limit - page properties: request_id: type: string description: 'An optional unique identifier for this search request (UUID v4 recommended). - In V1, `request_id` was required on every search call. In V5, it is optional. - Providing it is recommended for traceability and debugging. MoEngage support can use the value to locate the specific request in server logs. ' example: '{{request_id}}' campaign_fields: $ref: '#/components/schemas/CampaignSearchFieldsV5' include_child_campaigns: type: boolean default: false description: 'When `true`, includes child campaigns in results. Defaults to `false`. Child campaign types included: - **Periodic children:** Carry `parent_id` in the response. - **Flow-node campaigns:** Carry `flow_id` and `flow_name` in the response. ' include_archive_campaigns: type: boolean default: false description: 'When `true`, includes campaigns in `ARCHIVED` status in search results. By default, archived campaigns are excluded even if `ARCHIVED` is not in `campaign_fields.status`. Defaults to `false`. ' limit: type: integer description: 'The number of campaigns to return per page. **Maximum:** 15. The response does not include a `total_count` field - to determine the total number of results, keep paginating until a response returns fewer items than `limit`. ' minimum: 1 maximum: 15 example: 10 page: type: integer description: 'The page number to retrieve (1-indexed). For example, with 200 campaigns and a limit of 10, there are 20 pages. ' minimum: 1 example: 1 WebAdvanced: type: object description: 'Platform-level advanced settings for push delivery - TTL, priority, badge count, and similar controls. ' properties: icon_image_type: type: string enum: - DEFAULT - ICON_URL description: The type of icon to use for the notification. icon_url: type: string format: uri description: The URL for a custom notification icon. WebPushContent: type: object description: Web push notification content. properties: template_type: type: string enum: - BASIC description: The template type for web push (currently only BASIC is supported). basic_details: $ref: '#/components/schemas/WebBasicDetails' buttons: type: array items: $ref: '#/components/schemas/WebButton' description: 'Action buttons for the notification. ' advanced: $ref: '#/components/schemas/WebAdvanced' CarouselContent: type: object description: 'Configuration for image carousel in Simple Image Carousel template. **Required for:** Simple Image Carousel template ' properties: slider_transition: type: string enum: - MANUAL - AUTOMATIC description: 'The transition type for the carousel slides. In earlier versions of this API, the accepted values were `manual` and `automatic` (lowercase). They are now `MANUAL` and `AUTOMATIC` (uppercase). Update any existing integrations that pass lowercase values. ' slide_data: type: array description: Array of slide configurations. items: type: object properties: image_url: type: string format: uri description: The image URL for this slide. image_click_action: type: string enum: - DEEPLINKING - RICH_LANDING - NAVIGATE_TO_A_SCREEN description: The click action for this slide's image. image_click_action_value: type: string description: 'The click action value for this slide''s image. **Required** when image_click_action is provided. ' key_value_pairs: type: array items: $ref: '#/components/schemas/KeyValuePair' IOSBasicDetails: type: object description: Basic details for the iOS push notification. properties: background_color_code: type: string description: 'The hexadecimal color code for the notification''s background. **Supported Templates:** Simple Image Carousel, Stylized Basic ' example: '#a0a0a0' apply_background_color_in_text_editor: type: boolean description: 'Whether to apply the background color within the text editor view. **Supported Templates:** Simple Image Carousel, Stylized Basic ' title: type: string description: The main title of the push notification. example: New Message message: type: string description: The main body text of the notification. example: You have a new message waiting for you subtitle: type: string description: The subtitle displayed below the main title. allow_bg_refresh: type: boolean description: Whether to allow the app to be woken up in the background to refresh content. rich_media_type: type: string enum: - Image - Video - GIF description: 'The type of rich media to be included in the notification. **Supported Templates:** Basic ' rich_media_value: type: string format: uri description: 'The URL of the rich media asset specified in the rich_media_type field. **Supported Templates:** Basic ' image_url: type: string format: uri description: 'The URL of a large image to be displayed within the notification content. **Note:** Required when template_type is SIMPLE_IMAGE_CAROUSEL. ' input_gif_url: type: string format: uri description: 'The URL for the GIF media used in the push campaign content. **Supported Templates:** Basic, Stylized Basic ' carousel_content: $ref: '#/components/schemas/IOSCarouselContent' default_click_action: type: string enum: - DEEPLINKING - NAVIGATE_TO_A_SCREEN - RICH_LANDING description: The action performed when the main body of the notification is tapped. default_click_action_value: type: string description: The URL or deep link associated with the default click action. key_value_pairs: type: array items: $ref: '#/components/schemas/KeyValuePair' description: Custom key-value pairs sent with the push payload for in-app handling. CampaignAudienceLimit: type: object description: "Configuration for capping the number of users a campaign can reach (max-send).\n\nCampaign Audience Limit (also called max-send) caps how many users a single campaign can reach. Use it to control reach on high-volume campaigns and protect users from over-messaging. The cap can apply across the campaign's full lifetime (`frequency: TOTAL`) or per send instance (`frequency: INSTANCE`).\n\nFor runnable `TOTAL` (lifetime cap), `INSTANCE` (per-send cap, Periodic Push only), and disabled-cap examples, refer to [Campaign audience cap](/api/campaigns/audience-scheduling-delivery-reference#campaign-audience-cap).\n\n**Supported channels:** Email, Push.\n\n**Supported delivery types:**\n- All delivery types support `frequency: TOTAL` (lifetime cap).\n- `frequency: INSTANCE` (per-send cap) is supported only for **Periodic Push** campaigns.\n- `campaign_audience_limit` is not supported for `BROADCAST_LIVE_ACTIVITY`.\n\n**Flag-gated feature:** This feature is not enabled by default for any workspace and requires\nexplicit activation by your MoEngage account team. If you include `campaign_audience_limit` in\na request on a workspace where the flag has not been enabled, the API returns a `400` with the\nfollowing error body:\n\n```json\n{\n \"error\": {\n \"code\": \"VALIDATION_FAILED\",\n \"message\": \"Campaign Audience Limit feature is not enabled for this db\",\n \"target\": \"campaign_audience_limit\",\n \"details\": [\n {\n \"target\": \"campaign_audience_limit\",\n \"message\": \"Campaign Audience Limit feature is not enabled for this db\"\n }\n ]\n },\n \"response_id\": \"{{response_id}}\"\n}\n```\n\nWhen `is_campaign_audience_limit_enabled` is `true`, the fields `metric`, `frequency`, and\n`limit` are all required. When set to `false`, those three fields must not be provided.\n\nFor `ONE_TIME` campaigns, only `limit` and `is_campaign_audience_limit_enabled` are supported. Do not pass `metric` or `frequency`, they are only valid for `PERIODIC` and `EVENT_TRIGGERED` campaigns. \nPassing them for a ONE_TIME campaign causes the validate API to fail. \n" properties: is_campaign_audience_limit_enabled: type: boolean description: 'Whether the campaign audience limit is active. Set to `true` to enforce the cap; `false` to disable. When `true`, `metric`, `frequency`, and `limit` are all required. When `false`, `metric`, `frequency`, and `limit` must not be provided. ' metric: type: string description: 'The type of send event counted toward the limit. Must be uppercase. **Required** when `is_campaign_audience_limit_enabled` is `true`. ' enum: - SENT example: SENT frequency: type: string description: 'The window over which the limit is applied. Must be uppercase. - `TOTAL` - applies the cap across the full lifetime of the campaign. Supported for all delivery types on both Email and Push. - `INSTANCE` - applies the cap per campaign instance (for example, per periodic send). **Valid only for Push `PERIODIC` campaigns.** For all other delivery types, use `TOTAL`. **Required** when `is_campaign_audience_limit_enabled` is `true`. ' enum: - TOTAL - INSTANCE example: TOTAL limit: type: integer minimum: 1 maximum: 9999999999 description: 'The maximum number of users who can receive this campaign (or per instance, when `frequency` is `INSTANCE`). Must be between 1 and 9,999,999,999. **Required** when `is_campaign_audience_limit_enabled` is `true`. ' example: 100000 EmailBasicDetailsV5: type: object description: 'Identifying metadata for the Email campaign, including name, team, tags, and subscription category. **Conditional requirements:** `name`, `content_type`, `user_attribute_identifier`, and `subscription_category` are strictly required only when using the `/v5/campaigns/test` endpoint in **inline mode**. They are not required at campaign creation time (V5 supports progressive creation, where components are added later via PATCH) and are not needed in **draft mode** tests, where content comes from the saved draft. ' properties: name: type: string description: Any string name for the test or campaign. example: Summer Sale Email business_event: type: string description: The business event to be mapped to the campaign. example: user_signup content_type: type: string enum: - PROMOTIONAL - TRANSACTIONAL description: The type of content in the campaign. "PROMOTIONAL" or "TRANSACTIONAL". subscription_category: type: string description: 'The subscription category for promotional email campaigns. **Must match a valid category configured in your workspace.** **Required** for PROMOTIONAL email campaigns and inline tests. ' example: marketing tags: type: array items: type: string description: Tags that provide context about the campaign's nature or theme. example: - activation - summer_sale team: type: string description: The name of the team collaborating on this campaign. example: marketing_team user_attribute_identifier: type: string default: Email (Standard) description: 'The user attribute that stores the recipient email address. Use "Email (Standard)" for email channels. ' example: Email (Standard) Goal: type: object description: A single conversion goal configuration. properties: goal_name: type: string description: The name of the goal. example: Goal 1 goal_event_name: type: string description: The event name associated with this goal. goal_event_attribute: $ref: '#/components/schemas/GoalEventAttribute' is_primary_goal: type: boolean description: Whether this is the primary goal. revenue_attribute: type: string description: The revenue attribute to track. revenue_currency: type: string description: The currency for revenue tracking. ActionFilter: type: object title: Action-based filters (with or without attributes) description: 'Filter based on user actions/events. Use inside `segmentation_details.included_filters.filters` or `trigger_condition.included_filters.filters`. ' properties: filter_type: type: string enum: - actions action_name: type: string description: The name of the action/event to filter on. execution: type: object properties: type: type: string enum: - atleast - atmost - exactly count: type: integer executed: type: boolean description: Whether the action was executed. attributes: $ref: '#/components/schemas/FilterGroup' condition: type: string description: The condition type. Must be passed as the string "IF". VariationDetails: type: object description: 'Configuration for A/B testing variations. For runnable `MANUAL` (fixed split) and `SHERPA` (auto-optimized) examples, refer to [A/B test variations](/api/campaigns/campaign-content-reference#a-b-test-variations). ' properties: distribution_type: type: string enum: - SHERPA - MANUAL description: 'The traffic distribution method for A/B test variations. - `MANUAL` - you specify a fixed percentage split across variations. - `SHERPA` - MoEngage''s AI-powered optimizer automatically shifts traffic toward the best-performing variation during the campaign run. ' no_of_variations: type: integer minimum: 1 description: The number of A/B test variations. example: 2 manual_distribution_percentage: type: object additionalProperties: type: integer description: "Fixed percentage of audience assigned to each variation. \n**Note:** Variation keys must follow the `variation_N` naming format (e.g. `variation_1`, `variation_2`). Keys with any other format like `var_1`, `1`, `2` will be rejected with a validation error.\n\n**Required** when `distribution_type` is `MANUAL`.\n" example: variation_1: 50 variation_2: 50 sherpa_campaign_duration: type: integer description: 'Duration in hours over which MoEngage Sherpa collects performance data before declaring a winning variation. **Required** when `distribution_type` is `SHERPA`. ' sherpa_distribution_metric: type: string enum: - OPEN_RATE - CLICK_RATE - BOTH description: 'The engagement metric Sherpa uses to evaluate and rank variations. **Required** when `distribution_type` is `SHERPA`. ' PushCampaignContent: type: object description: 'Push message content, locales, and A/B variations. For full `POST /v5/campaigns` request examples that include `campaign_content`, refer to `campaign_delivery_type` on `PushCampaignCreateV5Request`, `VariationDetails`, and the Create Campaign Draft code samples. For per-template-type runnable payloads, refer to [Android push content](/api/campaigns/campaign-content-reference#android-push-content), [iOS push content](/api/campaigns/campaign-content-reference#ios-push-content), or [Web push content](/api/campaigns/campaign-content-reference#web-push-content). ' properties: locales: type: array items: type: string description: 'Additional locale names for multi-language campaigns. List only the non-default locales here (for example, `"en-US"`, `"es-ES"`). The `"default"` locale is always implicitly present and must not be included in this array. ' example: - en-US - es-ES variation_details: $ref: '#/components/schemas/VariationDetails' content: type: object description: 'The campaign message payload. Two shapes are accepted: - **Flat shape (no locales or variations):** Pass a flat `push` object directly under `content`. - **Locale-keyed and variation-keyed shape:** Key by locale name, then by variation name: `content[locale_name][variation_name] = { push: { ... } }`. The `"default"` locale key is always required and serves as the fallback. Additional locale keys must match values listed in `locales`. If your V1 integration used locale-variation wrapping, you must continue using that structure in V5. The flat format is only valid when no locales or A/B variations are configured on the campaign. For runnable payloads for both shapes, refer to [Content payload structure](/api/campaigns/campaign-content-reference#content-payload-structure). ' properties: push: $ref: '#/components/schemas/PushContent' additionalProperties: type: object description: Variation-keyed content blocks for a single locale. additionalProperties: type: object properties: push: $ref: '#/components/schemas/PushContent' PlatformSpecificDetails: type: object description: 'Platform-specific configuration details for Push. For runnable Android and iOS examples and the mutual-exclusion rule on iOS audience flags, refer to [Platform-specific delivery flags](/api/campaigns/campaign-content-reference#platform-specific-delivery-flags). ' properties: android: type: object properties: push_amp_plus_enabled: type: boolean default: false description: Whether Push Amp+ feature is enabled for this campaign. ios: type: object description: '**Note:** You must pass one of these keys as true for iOS. ' properties: send_to_all_eligible_device: type: boolean description: Whether to send the campaign to all eligible devices. exclude_provisional_push_devices: type: boolean description: Whether to exclude provisional push devices. send_to_only_provisional_push_enabled_devices: type: boolean description: Whether to send only to provisional push-enabled devices. AndroidBasicDetails: type: object description: "Basic details for the Android push notification. \n\nFields vary by template_type. All templates support common fields like title, message, default_click_action.\n" properties: notification_channel: type: string description: The Android notification channel where the push will be sent. example: general include_app_name_and_time: type: boolean description: 'Whether to include the application''s name and timestamp within the banner image. **Supported Templates:** Image Banner with Text ' background_color_code: type: string description: 'The hex code for the notification''s background color. **Supported Templates:** Stylized Basic, Simple Image Carousel, Image Banner with Text ' example: '#9a4444' app_name_color_code: type: string description: 'The hex code for the color of the application''s name text. **Supported Templates:** Stylized Basic, Simple Image Carousel, Image Banner with Text ' example: '#dea1a1' notification_control_color: type: string enum: - LIGHT - DARK description: 'The color scheme for the notification''s control elements (action buttons). **Supported Templates:** Stylized Basic, Simple Image Carousel, Image Banner with Text ' include_title_and_message: type: boolean description: 'Whether to include the notification''s title and message text within the banner image. **Supported Templates:** Image Banner with Text ' apply_background_color_in_text_editor: type: boolean description: 'Whether to apply the specified background color within the rich text editor for preview. **Supported Templates:** Stylized Basic, Simple Image Carousel, Image Banner with Text ' title: type: string description: The main title of the push notification. example: Limited Time Offer! message: type: string description: 'The message body of the push notification. You can use HTML in the message parameter to apply rich text formatting, including text color and styles. ' example: Get 50% off on all items. Shop now! summary: type: string description: The summary text for the notification. image_url: type: string format: uri description: The image URL for the push notification. example: https://example.com/images/promo.jpg image_scaling: type: string enum: - FIT_INSIDE_IMAGE_CONTAINER - FILL_IMAGE_CONTAINER description: 'The scaling behavior for images within the carousel template. **Supported Templates:** Simple Image Carousel, Image Banner with Text ' banner_image_url: type: string format: uri description: 'The URL for the background image used in the Image Banner Text template. **Required for:** Image Banner with Text template ' input_gif_url: type: string format: uri description: 'The URL for the GIF media used in the push campaign content. **Supported Templates:** Basic ' collapsed_push_notification: type: string description: 'The configuration for the notification''s collapsed state (view before user expands it). **Supported Templates:** Image Banner with Text ' example: SAME_AS_TEMPLATE_BACKUP carousel_content: $ref: '#/components/schemas/CarouselContent' default_click_action: type: string enum: - DEEPLINKING - NAVIGATE_TO_A_SCREEN - RICH_LANDING description: The action performed when the main body of the notification is clicked. default_click_action_value: type: string description: The URL or deep link to open when the notification is clicked. example: https://example.com/sale key_value_pairs: type: array items: $ref: '#/components/schemas/KeyValuePair' description: Custom key-value pairs for the notification payload. EmailDeliveryControls: type: object description: 'Controls for Email campaign delivery behavior. For runnable examples, refer to [Email delivery controls](/api/campaigns/audience-scheduling-delivery-reference#email-delivery-controls). ' properties: bypass_dnd: type: boolean description: Whether to bypass Do Not Disturb settings. campaign_throttle_rpm: type: integer description: The campaign throttle in requests per minute. example: 2000 count_for_frequency_capping: type: boolean description: Whether to count this campaign for frequency capping. ignore_frequency_capping: type: boolean description: Whether to ignore frequency capping for this campaign. minimum_delay_between_two_notification_in_hour: type: integer description: Minimum delay between two notifications in hours. CampaignSearchFieldsV5: type: object description: '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 single-element array to replicate V1 single-ID filtering. - `delivery_type` (V1) is `campaign_delivery_type` in V5. All other V1 filter fields (`channels`, `created_by`, `created_date`, `name`, `status`, `tags`) use the same names in V5. ' properties: ids: type: array items: type: string description: 'Filter by one or more campaign IDs. In V1, this field was `id` (a single string). In V5, it is `ids` (an array). For single-campaign retrieval, `GET /v5/campaigns/{campaign_id}` is the preferred endpoint. ' example: - 64a1b2c3d4e5f6a7b8c9d0e1 channels: type: array items: type: string enum: - EMAIL - PUSH description: Include campaigns for any of these channels. example: - PUSH - EMAIL created_by: type: array items: type: string format: email description: Include campaigns created by any of these users (email addresses). example: - marketer@example.com created_date: type: object description: Filter campaigns by creation date range. properties: from_date: type: string format: date-time description: Start of the creation date range (ISO 8601 format). example: '2024-01-01T00:00:00' to_date: type: string format: date-time description: End of the creation date range (ISO 8601 format). example: '2024-12-31T23:59:59' campaign_delivery_type: type: array items: type: string enum: - ONE_TIME - PERIODIC - EVENT_TRIGGERED - BUSINESS_EVENT_TRIGGERED - DEVICE_TRIGGERED - LOCATION_TRIGGERED description: 'Include campaigns with any of these delivery types. In V1, this field was `delivery_type`. In V5, it is `campaign_delivery_type`. ' example: - ONE_TIME - PERIODIC name: type: string description: Filter campaigns by name. Partial matches are supported. example: Summer Sale status: type: array items: type: string enum: - DRAFT - ACTIVE - SCHEDULED - PAUSED - SENT - SENDING - STOPPED - ARCHIVED description: 'Include campaigns in any of these statuses. Drafts are only returned when `DRAFT` is explicitly included here. ' tags: type: array items: type: string description: Include campaigns that have any of these tags. example: - promotional - seasonal version_number: type: integer description: 'Filter by campaign version. Only applies when campaign versioning is enabled for your workspace. Omit to include all versions. ' SchedulingDetails: type: object description: 'Defines when the campaign should be sent. For per-delivery-type runnable payloads (`ASAP`, `AT_FIXED_TIME`, `SEND_IN_BTS`, `SEND_IN_USER_TIMEZONE`, and `PERIODIC` with `periodic_details`), refer to [Campaign delivery schedule](/api/campaigns/audience-scheduling-delivery-reference#campaign-delivery-schedule). ' properties: delivery_type: type: string enum: - ASAP - AT_FIXED_TIME - SEND_IN_BTS - SEND_IN_USER_TIMEZONE description: 'When to deliver the campaign. ' start_time: type: string format: date-time description: 'The start time for the campaign in ISO 8601 format. Interpreted in the timezone specified by the `timezone` field. If `timezone` is not provided, pass this value in UTC. Example: "2024-06-21T12:59:00" ' expiry_time: type: string format: date-time description: 'The expiry time for the campaign in ISO 8601 format. Interpreted in the timezone specified by the `timezone` field. If `timezone` is not provided, pass this value in UTC. ' timezone: type: string description: 'IANA timezone string for the campaign schedule (for example, `Asia/Kolkata`). Required when `delivery_type` is `AT_FIXED_TIME` or `SEND_IN_BTS`. Optional for `SEND_IN_USER_TIMEZONE`, where each user''s own timezone is used. ' example: Asia/Kolkata periodic_details: $ref: '#/components/schemas/PeriodicDetails' bts_details: $ref: '#/components/schemas/BTSDetails' user_timezone_details: $ref: '#/components/schemas/UserTimezoneDetails' geo_fence_timelimit: type: object description: 'Defines the delivery time window for location-triggered campaigns. When configured, notifications are delivered only within the specified schedule. **Applicable for:** `LOCATION_TRIGGERED` campaigns. ' properties: notification_schedule: type: string enum: - ALWAYS - LIMITED_TIME description: Controls when delivery is permitted. Set to `ALWAYS` to allow delivery at any time, or `LIMITED_TIME` to restrict delivery to the configured time bounds. timebounds: type: array description: 'One or more start and end time windows within which delivery is permitted. **Required** when `notification_schedule` is `LIMITED_TIME`. ' items: type: object properties: start_time: type: string format: date-time description: Start of the delivery window in ISO 8601 format. example: '2027-06-19T11:02:00' end_time: type: string format: date-time description: End of the delivery window in ISO 8601 format. example: '2029-06-20T13:55:00' EmailContent: type: object description: Email campaign content. properties: subject: type: string description: The subject line of the email. example: Exclusive Summer Sale - 50% Off! preview_text: type: string description: The preview text shown in email clients. example: Don't miss out on our biggest sale of the season sender_name: type: string description: The name of the sender that appears in the email. example: MoEngage Team from_address: type: string format: email description: The sender's email address. example: noreply@example.com reply_to_address: type: string format: email description: The reply-to email address. example: support@example.com cc_ids: type: array items: type: string format: email description: Email addresses to CC. For runnable examples, refer to [Email content variants](/api/campaigns/campaign-content-reference#email-content-variants). bcc_ids: type: array items: type: string format: email description: Email addresses to BCC. For runnable examples, refer to [Email content variants](/api/campaigns/campaign-content-reference#email-content-variants). html_content: type: string description: 'The HTML content of the email. **Optional** if custom_template_id is provided. ' example:

Hello {{UserAttribute['First Name']}}

email_editor: type: string enum: - Froala Editor - Ace Editor description: 'The HTML editor used for the email campaign. - **Required** if you want to create the campaign using the `Ace Editor`. - **Optional** if you want to use the default `Froala Editor`. ' example: Ace Editor custom_template_id: type: string description: 'The ID of a custom email template. **Optional** if html_content is provided. When this field is provided, the following fields are not required: - subject - preview_text - sender_name ' custom_template_version: type: integer description: The version of the custom template. attachments: type: array items: type: object properties: file_type: type: string enum: - URL - PERSONALIZED_ATTACHMENT url: type: string description: 'Attachments to include in the email. ' CampaignDetailsResponse: type: object description: 'Detailed information about a campaign returned by GET `/v5/campaigns/{campaign_id}` and POST `/v5/campaigns/search`. **Identifier change from V1 to V5:** - In V1, the campaign identifier was returned as `campaign_id`. In V5, it is returned as `id`. - The legacy `campaign_id` field may also be present alongside `id` for backward compatibility, but `id` is the canonical V5 identifier. **V1 fields preserved in V5 under the same names:** `created_by`, `updated_by`, `created_at`, `updated_at`, `sent_time`, `flow_id`, `flow_name`, `parent_id`, `connector`, `utm_params`, `campaign_audience_limit`. ' properties: id: type: string description: 'The unique document identifier for this campaign revision. In V1, this field was `campaign_id`. In V5, it is `id`. ' example: 64a1b2c3d4e5f6a7b8c9d0e1 campaign_id: type: string description: 'The canonical campaign identifier shared across all versions of the campaign when campaign versioning is enabled. In non-versioned workspaces, `campaign_id` equals `id`. ' example: camp_abc123xyz version_number: type: integer description: 'Monotonic version index for this campaign document when campaign versioning is enabled. Publishing edits to a previously published campaign creates a new document with a higher `version_number`. `campaign_id` is the canonical identifier shared across versions; `id` is unique per document. ' status: type: string enum: - DRAFT - ACTIVE - SCHEDULED - PAUSED - SENT - SENDING - STOPPED - ARCHIVED description: The current status of the campaign. channel: type: string enum: - PUSH - EMAIL - SMS description: The communication channel. campaign_delivery_type: type: string enum: - ONE_TIME - PERIODIC - EVENT_TRIGGERED - BUSINESS_EVENT_TRIGGERED - DEVICE_TRIGGERED - LOCATION_TRIGGERED - BROADCAST_LIVE_ACTIVITY description: The delivery type of the campaign. created_by: type: string format: email description: The email ID of the user who created the campaign. updated_by: type: string format: email description: The email ID of the user who last updated the campaign. created_at: type: string description: The timestamp when the campaign was created, in UTC. example: '2024-07-04 08:00:54.847000' updated_at: type: string description: The timestamp when the campaign was last updated, in UTC. sent_time: type: string description: The timestamp when the campaign was sent, in UTC. example: '2024-07-04 20:32:00' flow_id: type: string description: 'The flow ID (only for flow campaigns). Only applicable when `include_child_campaigns` is true. ' flow_name: type: string description: 'The flow name (only for flow campaigns). Only applicable when `include_child_campaigns` is true. ' parent_id: type: string description: 'The campaign ID of the parent campaign. Only applicable for periodic child campaigns when `include_child_campaigns` is true. ' basic_details: description: 'Basic campaign settings - name, tags, team, platform targets, and channel-specific identifiers. Structure varies by channel: - **Push:** See `PushBasicDetailsV5` schema (name, platforms, tags, team, geofences, etc.) - **Email:** See `EmailBasicDetailsV5` schema (name, content_type, subscription_category, user_attribute_identifier, etc.) - **SMS:** connector, sender name, and similar fields. ' oneOf: - $ref: '#/components/schemas/PushBasicDetailsV5' - $ref: '#/components/schemas/EmailBasicDetailsV5' campaign_content: description: 'The full campaign content payload including locales and A/B test variations. Structure varies by channel: - **Push:** See `PushCampaignContent` schema. - **Email:** See `EmailCampaignContent` schema. ' oneOf: - $ref: '#/components/schemas/PushCampaignContent' - $ref: '#/components/schemas/EmailCampaignContent' trigger_condition: description: 'Trigger condition for event-triggered campaigns. Structure varies by channel: - **Push:** See `PushTriggerCondition` schema (supports INTELLIGENT_DELAY). - **Email:** See `EmailTriggerCondition` schema. ' oneOf: - $ref: '#/components/schemas/PushTriggerCondition' - $ref: '#/components/schemas/EmailTriggerCondition' segmentation_details: $ref: '#/components/schemas/SegmentationDetails' scheduling_details: description: 'Scheduling configuration as resolved on the campaign. The response is a normalized, read-only view and can include fields that are not part of the `SchedulingDetails` request schema: - `delivery_type` may be returned as `SCHEDULED` (a resolved response value, not one of the request enum values). - `schedule_time` holds the resolved send time and corresponds to the request-side `start_time`. - `time_zone` holds the resolved IANA time zone the schedule is interpreted in. Treat these as response-only fields. Use the `SchedulingDetails` request schema when constructing create or update payloads. ' allOf: - $ref: '#/components/schemas/SchedulingDetails' delivery_controls: description: 'Delivery control settings. Structure varies by channel: - **Push:** See `PushDeliveryControls` schema (bypass_dnd, campaign_throttle_rpm, ignore_frequency_capping, etc.) - **Email:** See `EmailDeliveryControls` schema. ' oneOf: - $ref: '#/components/schemas/PushDeliveryControls' - $ref: '#/components/schemas/EmailDeliveryControls' advanced: description: Advanced campaign settings (for Push campaigns). See the `AdvancedDetails` schema for child properties such as `expiration_settings` and `platform_level_priority`. allOf: - $ref: '#/components/schemas/AdvancedDetails' conversion_goal_details: $ref: '#/components/schemas/ConversionGoalDetails' control_group_details: $ref: '#/components/schemas/ControlGroupDetails' utm_params: $ref: '#/components/schemas/UTMParams' connector: type: object description: 'Connector configuration (for Email and SMS campaigns). ' properties: connector_type: type: string example: SENDGRID connector_name: type: string example: default sender_name: type: string description: 'The sender name configured for the campaign. Only applicable for SMS campaigns. ' campaign_audience_limit: $ref: '#/components/schemas/CampaignAudienceLimit' FilterGroup: type: object description: 'A group of filters combined with a logical operator. For detailed segmentation payload and supported fields, refer to [Create Custom Segment](https://developers.moengage.com/hc/en-us/articles/13277936457748). ' properties: filter_operator: type: string enum: - and - or description: The logical operator to combine filters. filters: type: array items: oneOf: - $ref: '#/components/schemas/UserAttributeFilter' - $ref: '#/components/schemas/ActionFilter' - $ref: '#/components/schemas/CustomSegmentFilter' description: 'The list of filters to be combined using the filter operator. Supported filter types: - User attributes-based filters - Action-based filters (with or without attributes) - Custom segments ' PushContent: type: object description: Push notification content for Android, iOS, and Web platforms. properties: android: $ref: '#/components/schemas/AndroidPushContent' ios: $ref: '#/components/schemas/IOSPushContent' web: $ref: '#/components/schemas/WebPushContent' AndroidAdvanced: type: object description: Platform-level advanced settings for push delivery - TTL, priority, badge count, and similar controls. properties: coupon_code: type: string description: The coupon code to be included in the push payload. example: SUMMER50 icon_type_in_notification: type: string description: The icon type to be included in the push payload. example: app_icon use_large_icon: type: boolean description: Whether to use a large icon in the notification. make_notification_sticky: type: boolean description: 'When enabled, the user cannot swipe away the notification. ' dismiss_button_text: type: string description: 'The text to display on the dismiss button. **Required** when make_notification_sticky is true or auto_dismiss_notification is true. ' auto_dismiss_notification: type: boolean description: Whether the notification can be auto-dismissed. auto_dismiss_notification_time_value: type: integer description: 'The time value after which to auto-dismiss the notification. **Required** when auto_dismiss_notification is true. ' auto_dismiss_notification_time_granularity: type: string enum: - DAYS - HOURS - MINUTES description: 'The time unit for auto-dismiss. **Required** when auto_dismiss_notification is true. ' group_key: type: string description: 'The group key used to identify and categorize related push notifications. **Note:** - Use the same group key for all push notifications you want to group - MoEngage automatically modifies the group key to ensure it doesn''t exceed 45 characters - Non-Latin scripts, special characters, and spaces are removed ' collapse_replace_key: type: string description: 'The update key used to identify and update related push notifications. Ensure you use the same update key for all push notifications intended to update each other. ' IOSCarouselContent: type: object description: 'Configuration for image carousel in Simple Image Carousel template. **Required for:** Simple Image Carousel template ' properties: slider_transition: type: string enum: - MANUAL - AUTOMATIC description: 'The transition type for the carousel slides. In earlier versions of this API, the accepted values were `manual` and `automatic` (lowercase). They are now `MANUAL` and `AUTOMATIC` (uppercase). Update any existing integrations that pass lowercase values. ' slide_data: type: array description: Array of slide configurations. items: type: object properties: image_url: type: string format: uri description: The image URL for this slide. image_click_action: type: string enum: - DEEPLINKING - RICH_LANDING - NAVIGATE_TO_A_SCREEN description: The click action for this slide's image. image_click_action_value: type: string description: The click action value for this slide's image. key_value_pairs: type: array items: $ref: '#/components/schemas/KeyValuePair' WebButton: type: object description: Action button configuration for Web push notifications. properties: title: type: string description: The text displayed on the button. example: View Offer icon_url: type: string format: uri description: The URL of an icon to be displayed next to the button text. url: type: string format: uri description: The destination URL that the user is redirected to when they click this button. UserTimezoneDetails: type: object description: 'Configuration for sending in the user''s timezone. For the field schema and required-when-`SEND_IN_USER_TIMEZONE` rule, refer to [User timezone](/api/campaigns/audience-scheduling-delivery-reference#user-timezone). ' properties: send_in_user_timezone: type: boolean description: Whether to send the campaign on a specific date and time within the user's timezone. send_if_user_timezone_has_passed: type: boolean description: Whether to send the campaign if the user's timezone has passed. MetaV5Request: type: object required: - limit - page properties: request_id: type: string description: A unique identifier for this metadata retrieval request. example: '{{request_id}}' campaign_fields: $ref: '#/components/schemas/CampaignMetaSearchFieldsV5' include_child_campaigns: type: boolean default: false description: 'When `true`, returns child campaign metadata for periodic campaigns. Activates the following response fields on each campaign object: - `total_child_campaigns` - number of child campaigns (present on the parent campaign). - `parent_campaign_id` - the parent campaign''s ID (present on each child campaign). Defaults to `false`. ' limit: type: integer description: 'The number of campaigns to display per page. **Maximum:** 15. The response does not include a `total_count` field - to determine the total number of results, keep paginating until a response returns fewer items than `limit`. ' minimum: 1 maximum: 15 example: 15 page: type: integer description: 'The page number to retrieve. For example, if there are 200 campaigns and the limit is 10, there will be 20 pages. ' minimum: 1 example: 1 CampaignMetaSearchFieldsV5: type: object description: Filter criteria for retrieving campaign metadata. properties: id: type: string description: 'The unique identifier of the campaign to retrieve. ' example: '{{campaign_id}}' channels: type: array items: type: string enum: - EMAIL - PUSH - SMS - WHATSAPP - FACEBOOK - GOOGLE ADS - CONNECTORS description: 'Include campaigns for any of these channels. ' example: - PUSH - EMAIL created_by: type: array items: type: string format: email description: Include campaigns created by any of these users (email addresses). example: - user@example.com created_date: type: object description: Filter campaigns by creation date range. properties: from_date: type: string format: date-time description: Start of the creation date range (ISO 8601 format). example: '2024-01-01T00:00:00' to_date: type: string format: date-time description: End of the creation date range (ISO 8601 format). example: '2024-12-31T23:59:59' delivery_type: type: string enum: - ONE_TIME - PERIODIC - EVENT_TRIGGERED - BUSINESS_EVENT_TRIGGERED - DEVICE_TRIGGERED - LOCATION_TRIGGERED description: 'Filter campaigns by delivery type. ' name: type: string description: Filter campaigns by name. Partial matches are supported. example: Summer Sale status: type: array items: type: string enum: - DRAFT - SCHEDULED - ACTIVE - PAUSED - SENT - SENDING - STOPPED - ARCHIVED description: Include campaigns in any of these statuses. tags: type: array items: type: string description: Include campaigns that have any of these tags. example: - promotional - seasonal EmailTriggerCondition: type: object description: 'Trigger condition details for Email event-triggered campaigns. **Required** for EVENT_TRIGGERED campaigns. For per-delay-type runnable payloads (`ASAP`, `DELAY` with `AFTER`/`BEFORE`), filter primitives, and primary/secondary filter combinations, refer to [Trigger conditions](/api/campaigns/audience-scheduling-delivery-reference#trigger-conditions). ' properties: included_filters: $ref: '#/components/schemas/FilterGroup' secondary_included_filters: allOf: - $ref: '#/components/schemas/FilterGroup' description: Additional filters that must also be satisfied for the Email trigger to fire. For runnable examples, refer to [Primary and secondary trigger filters](/api/campaigns/audience-scheduling-delivery-reference#primary-and-secondary-trigger-filters). trigger_delay_type: type: string enum: - DELAY - ASAP description: 'The type of triggered delay. When set to DELAY, the following fields are mandatory: - trigger_delay_value - trigger_delay_granularity - trigger_relation ' trigger_delay_value: type: integer minimum: 0 description: The numeric value of the triggered delay. trigger_delay_granularity: type: string enum: - MINUTES - HOURS - DAYS description: The time unit for the trigger delay. trigger_relation: type: string enum: - BEFORE - AFTER description: 'The trigger relation with delay. **Required** when trigger_delay_type is DELAY. ' trigger_attr: type: string description: The attribute value of the trigger. Pass the string `"If Action"` for event-triggered campaigns. GetChildCampaignsRequest: type: object description: You can request to retrieve child campaign execution details. required: - request_id - limit - page properties: request_id: type: string description: A unique identifier for this child campaigns retrieval request. example: child_req_12345 limit: type: integer description: 'The number of child campaigns to display per page. **Maximum:** 15 ' minimum: 1 maximum: 15 example: 15 page: type: integer description: 'The page number to retrieve. For example, if there are 100 child campaigns and limit is 10, there will be 10 pages. ' minimum: 1 example: 1 CampaignMetaResponse: type: object description: Campaign metadata including basic information and reachability details. properties: campaign_id: type: string description: The unique ID of the campaign. example: camp_abc123xyz channel: type: string enum: - EMAIL - PUSH - SMS - WHATSAPP - FACEBOOK - GOOGLE ADS - CONNECTORS description: The communication channel. platform: type: array items: type: string enum: - ANDROID - IOS - WEB description: The platform types supported for the campaign (applicable for Push). created_by: type: string format: email description: The email ID of the user who created the campaign. campaign_delivery_type: type: string enum: - ONE_TIME - PERIODIC - EVENT_TRIGGERED - BUSINESS_EVENT_TRIGGERED - DEVICE_TRIGGERED - LOCATION_TRIGGERED - BROADCAST_LIVE_ACTIVITY description: The delivery type of the campaign. campaign_name: type: string description: The name of the campaign. example: Summer Sale Campaign campaign_team: type: string description: The team name associated with the campaign. campaign_tags: type: array items: type: string description: Tags associated with the campaign. campaign_status: type: string enum: - SCHEDULED - ACTIVE - PAUSED - SENT - STOPPED - RETIRED - ARCHIVED description: 'The current status of the campaign. `RETIRED` is a terminal status applied automatically to campaigns that have reached their end condition. Retired campaigns cannot be reactivated and are distinct from `STOPPED` (manually halted) and `ARCHIVED` (explicitly archived). ' campaign_start_time: type: string format: date-time description: The start time of the campaign in ISO 8601 format. This value is returned in UTC. example: '2024-11-28T12:18:00' parent_campaign_id: type: string description: 'The campaign ID of the parent campaign. Only shown if the requested campaign_id belongs to a child campaign and `include_child_campaigns` is true. ' total_child_campaigns: type: integer description: 'The number of child campaigns. Only shown if the campaign_id belongs to a parent campaign. Only applicable for periodic campaigns. ' reachability_details: type: object description: 'Reachability information for the campaign. **Important:** Only populated for **scheduled** campaigns (one-time, business event-triggered, and event-triggered). Reachability is calculated once daily and cached for 24 hours. ' properties: count: type: integer description: The estimated number of users the scheduled campaign will reach. example: 18182 last_updated_time: type: string format: date-time description: The timestamp when reachability was last calculated, in ISO 8601 format. This value is returned in UTC. example: '2024-11-27T09:05:42.661000' ConversionGoalDetails_2: type: object description: Configuration for tracking campaign conversion goals. properties: attribution_window_in_hours: type: integer description: The attribution window in hours. example: 36 goals: type: array items: $ref: '#/components/schemas/Goal' description: List of conversion goals to track. PeriodicDetails_2: type: object description: 'Configuration for periodic campaigns. **Required** for PERIODIC campaigns. ' properties: sending_frequency: type: string enum: - DAILY - WEEKLY - MONTHLY description: The frequency to send the campaign. repeat_frequency: type: integer description: The repeat frequency of the campaign. no_of_occurences: type: integer description: The number of occurrences of the campaign. repeat_on_date_of_month: type: array items: type: integer description: 'The dates of the month on which the campaign should be repeated. Example: [5, 25] to send on the 5th and 25th of each month. ' repeat_on_days_of_week: type: array items: type: string enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY description: The days of the week on which the campaign should repeat. repeat_on_days_of_week_for_month: type: array items: type: object properties: week_granularity: type: string enum: - FIRST - SECOND - THIRD - FOURTH - LAST repeat_on_days_of_week: type: array items: type: string enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY description: Configuration for repeating on specific weeks of the month. SegmentationDetails_2: type: object description: Defines the target audience for the campaign. properties: included_filters: $ref: '#/components/schemas/FilterGroup_2' excluded_filters: $ref: '#/components/schemas/FilterGroup_2' is_all_user_campaign: type: boolean description: Whether to include all users in the campaign. send_campaign_to_opt_out_users: type: boolean description: Whether to send the campaign to users who have opted out. ControlGroupDetails_2: type: object description: Configuration for control groups. properties: is_campaign_control_group_enabled: type: boolean description: Whether the campaign control group is enabled. campaign_control_group_percentage: type: integer description: 'The percentage of users added to the exclusion list. **Required** if is_campaign_control_group_enabled is true. ' minimum: 0 maximum: 100 is_global_control_group_enabled: type: boolean description: Whether the global control group is enabled. UserAttributeFilter_2: type: object description: Filter based on user attributes. required: - filter_type - data_type - name - operator properties: filter_type: type: string enum: - user_attributes data_type: type: string enum: - string - double - datetime - bool description: The data type of the attribute being filtered. category: type: string description: The category of the attribute (e.g., "Tracked Standard Attribute"). name: type: string description: The name of the attribute to filter on (e.g., "uid"). operator: type: string description: 'The operator to use in the filter. Allowed values depend on data_type: - bool: is, exists - double: in, between, lessThan, greaterThan, exists - string: in, contains, containsInTheFollowing, startWithInTheFollowing, endsWithInTheFollowing, exists, is - datetime: inTheLast, on, between, before, after, inTheNext, exists, today ' value: description: The value to filter on (not required for 'exists' operator). case_sensitive: type: boolean description: Whether the filter comparison should be case-sensitive. negate: type: boolean description: Whether to negate the filter condition. project_name: type: string description: 'The name of the project associated with the user attributes. **Required** if the Portfolio feature is enabled in your workspace. ' BTSDetails_2: type: object description: 'Best Time to Send (BTS) configuration. BTS provides a prescriptive time slot to send a campaign to increase the chance of user interaction. ' properties: send_in_bts: type: boolean description: Whether to send the campaign at the best time. if_user_bts_is_not_available: type: string description: When to send the campaign if the user's best time is not available. if_user_bts_outside_time_window: type: string description: When to send the campaign if the user's best time is outside the time window. window_end_time: type: string description: The window end time. example: 6:43 am UTMParams_2: type: object description: UTM parameters for tracking campaign performance. required: - utm_source - utm_medium properties: utm_source: type: string description: 'The source of the traffic (e.g., YouTube, Instagram, Google). **Required** when using UTM parameters. ' example: google utm_medium: type: string description: 'The channel type (e.g., Push, SMS, Email). **Required** when using UTM parameters. ' example: email utm_campaign: type: string description: The name of the campaign (e.g., Newyear, Bigbillionday). example: summer_sale utm_term: type: string description: Search terms for paid traffic (e.g., Mobile+sale). utm_content: type: string description: The content element that differentiates links (e.g., banner, video). utm_custom: type: string description: Custom UTM parameter (maximum of 5 custom parameters). CampaignMetaRequest: type: object required: - request_id - limit - page properties: request_id: type: string description: A unique identifier for this metadata retrieval request. example: meta_req_12345 campaign_fields: $ref: '#/components/schemas/CampaignMetaSearchFields' include_child_campaigns: type: boolean description: 'Whether to include child campaign information. Set to `true` to fetch details of child campaigns (flow nodes and periodic children). Use `flow_id`, `flow_name`, or `parent_campaign_id` in the response to identify relationships. ' default: false limit: type: integer description: 'The number of campaigns to display per page. **Maximum:** 15 ' minimum: 1 maximum: 15 example: 15 page: type: integer description: 'The page number to retrieve. For example, if there are 200 campaigns and limit is 10, there will be 20 pages. ' minimum: 1 example: 1 CustomSegmentFilter_2: type: object description: Filter using a custom segment. required: - filter_type - id properties: filter_type: type: string enum: - custom_segments name: type: string description: The name of the custom segment. id: type: string description: The ID of the custom segment. CampaignAudienceLimit_2: type: object description: Configuration for limiting campaign audience. properties: limit: type: integer description: 'The maximum number of times an audience can be included or targeted within the campaign. ' metrics: type: string description: 'The type of measurement being tracked (e.g., impressions, clicks, conversions). ' frequency: type: string description: 'How often the limit and metrics are applied (e.g., daily, weekly, monthly). ' ActionFilter_2: type: object description: Filter based on user actions/events. required: - filter_type - action_name properties: filter_type: type: string enum: - actions action_name: type: string description: The name of the action/event to filter on. execution: type: object properties: type: type: string enum: - atleast - atmost - exactly count: type: integer executed: type: boolean description: Whether the action was executed. attributes: $ref: '#/components/schemas/FilterGroup_2' condition: type: string description: The condition type (e.g., "IF"). CampaignSearchFields: type: object description: Filter criteria for searching campaigns. properties: channels: type: array items: type: string enum: - PUSH - EMAIL - SMS description: Filter campaigns by channel type. example: - PUSH - EMAIL created_by: type: array items: type: string format: email description: 'Filter campaigns by the email ID of the user who created them. **Note:** Only email IDs are supported. ' example: - john.doe@example.com created_date: type: object description: Filter campaigns by creation date range. properties: from_date: type: string format: date description: 'The starting point of the date range. **Recommended format:** YYYY-MM-DD ' example: '2024-01-01' to_date: type: string format: date description: 'The ending point of the date range. **Recommended format:** YYYY-MM-DD ' example: '2024-12-31' delivery_type: type: array items: type: string enum: - ONE_TIME - PERIODIC - EVENT_TRIGGERED - BUSINESS_EVENT_TRIGGERED - DEVICE_TRIGGERED - LOCATION_TRIGGERED - BROADCAST_LIVE_ACTIVITY description: Filter campaigns by delivery type. example: - ONE_TIME - PERIODIC id: type: string description: Filter by specific campaign ID. example: camp_abc123xyz name: type: string description: Filter by campaign name. example: Summer Sale Campaign status: type: array items: type: string enum: - ACTIVE - SCHEDULED - PAUSED - SENT - STOPPED - ARCHIVED description: Filter campaigns by status. example: - ACTIVE - SCHEDULED tags: type: array items: type: string description: Filter campaigns by tags. example: - sale - promotion ChildCampaignsResponse: type: object description: Response containing child campaign execution details. properties: executions: type: array description: Array of child campaign execution details. items: type: object properties: campaign_id: type: string description: The unique ID of the child campaign. example: camp_child_001 sent_time: type: string description: The timestamp when the child campaign was sent, in UTC. example: '2024-06-24T14:30:18.908000' status: type: string enum: - Sent - Sending - Scheduled - Failed description: The status of the child campaign. total_instances: type: integer description: The total number of times the parent campaign has been executed. example: 8 SchedulingDetails_2: type: object description: Defines when the campaign should be sent. All date-time values must be passed in UTC. required: - delivery_type properties: delivery_type: type: string enum: - ASAP - AT_FIXED_TIME - SEND_IN_BTS - SEND_IN_USER_TIMEZONE description: When to deliver the campaign. start_time: type: string format: date-time description: 'The start time for the campaign in ISO 8601 format. Pass this value in UTC. Example: "2024-06-21T12:59:00" ' expiry_time: type: string format: date-time description: The expiry time for the campaign in ISO 8601 format. Pass this value in UTC. periodic_details: $ref: '#/components/schemas/PeriodicDetails_2' bts_details: $ref: '#/components/schemas/BTSDetails_2' user_timezone_details: $ref: '#/components/schemas/UserTimezoneDetails_2' CampaignMetaSearchFields: type: object description: Filter criteria for retrieving campaign metadata. properties: id: type: string description: The unique identifier to identify the campaign. example: camp_abc123xyz channels: type: array items: type: string enum: - EMAIL - PUSH - SMS - WHATSAPP - FACEBOOK - GOOGLE ADS - CONNECTORS description: Filter campaigns by channel type. example: - EMAIL - PUSH created_by: type: array items: type: string format: email description: 'Filter by email ID of the user who created the campaign. **Note:** Only email IDs are supported. ' example: - john.doe@example.com created_date: type: object description: Filter campaigns by creation date range. required: - from_date - to_date properties: from_date: type: string description: 'The starting point of the date range in which campaigns were created. **Recommended format:** YYYY-MM-DD or DD-MM-YYYY ' example: '2024-01-01' to_date: type: string description: 'The ending point of the date range in which campaigns were created. **Recommended format:** YYYY-MM-DD or DD-MM-YYYY ' example: '2024-12-31' delivery_type: type: array items: type: string enum: - ONE_TIME - PERIODIC - EVENT_TRIGGERED - BUSINESS_EVENT_TRIGGERED description: Filter campaigns by delivery type. example: - ONE_TIME name: type: string description: Filter by campaign name. example: Summer Sale Campaign status: type: array items: type: string enum: - SCHEDULED - ACTIVE - PAUSED - SENT - STOPPED - RETIRED - ARCHIVED description: 'Filter campaigns by status. `RETIRED` is a terminal status applied automatically to campaigns that have reached their end condition (for example, a campaign whose end date has passed). Retired campaigns cannot be reactivated. This status is distinct from `STOPPED` (manually halted) and `ARCHIVED` (explicitly archived by a user). ' example: - SCHEDULED - ACTIVE tags: type: array items: type: string description: Filter campaigns by tags that describe the campaign's nature or theme. example: - promotion - sale ErrorResponse: type: object properties: error: type: object properties: code: type: string description: The error code (e.g., "400 Bad Request"). message: type: string description: Description of why the request failed. target: type: string description: The target of the error. details: type: array items: type: object properties: target: type: string message: type: string request_id: type: string description: The request ID associated with this error. CampaignDetailsResponse_2: type: object description: Detailed information about a campaign. properties: campaign_id: type: string description: The unique ID of the campaign. example: camp_abc123xyz status: type: string enum: - ACTIVE - SCHEDULED - PAUSED - SENT - STOPPED - ARCHIVED description: The current status of the campaign. channel: type: string enum: - PUSH - EMAIL - SMS description: The communication channel. campaign_delivery_type: type: string enum: - ONE_TIME - PERIODIC - EVENT_TRIGGERED - BUSINESS_EVENT_TRIGGERED - DEVICE_TRIGGERED - LOCATION_TRIGGERED - BROADCAST_LIVE_ACTIVITY description: The delivery type of the campaign. created_by: type: string format: email description: The email ID of the user who created the campaign. updated_by: type: string format: email description: The email ID of the user who last updated the campaign. created_at: type: string description: The timestamp when the campaign was created, in UTC. example: '2024-07-04 08:00:54.847000' updated_at: type: string description: The timestamp when the campaign was last updated, in UTC. sent_time: type: string description: The timestamp when the campaign was sent, in UTC. example: '2024-07-04 20:32:00' flow_id: type: string description: 'The flow ID (only for flow campaigns). Only applicable when `include_child_campaigns` is true. ' flow_name: type: string description: 'The flow name (only for flow campaigns). Only applicable when `include_child_campaigns` is true. ' parent_id: type: string description: 'The campaign ID of the parent campaign. Only applicable for periodic child campaigns when `include_child_campaigns` is true. ' basic_details: type: object description: 'Basic details of the campaign. Structure varies by channel (Push/Email/SMS). ' campaign_content: type: object description: The campaign content including locales and variations. trigger_condition: type: object description: 'Trigger condition details for event-triggered campaigns. Structure varies by channel (Push supports INTELLIGENT_DELAY, Email does not). ' segmentation_details: $ref: '#/components/schemas/SegmentationDetails_2' scheduling_details: $ref: '#/components/schemas/SchedulingDetails_2' delivery_controls: type: object description: Delivery control settings for the campaign. advanced: type: object description: Advanced campaign settings (for Push campaigns). conversion_goal_details: $ref: '#/components/schemas/ConversionGoalDetails_2' control_group_details: $ref: '#/components/schemas/ControlGroupDetails_2' utm_params: $ref: '#/components/schemas/UTMParams_2' connector: type: object description: 'Connector configuration (for Email and SMS campaigns). ' properties: connector_type: type: string example: SENDGRID connector_name: type: string example: default sender_name: type: string description: 'The sender name configured for the campaign. Only applicable for SMS campaigns. ' campaign_audience_limit: $ref: '#/components/schemas/CampaignAudienceLimit_2' FilterGroup_2: type: object description: 'A group of filters combined with a logical operator. For detailed segmentation payload and supported fields, refer to [Create Custom Segment](/api/filter-segments/create-filter-segment). ' required: - filter_operator - filters properties: filter_operator: type: string enum: - and - or description: The logical operator to combine filters. filters: type: array items: oneOf: - $ref: '#/components/schemas/UserAttributeFilter_2' - $ref: '#/components/schemas/ActionFilter_2' - $ref: '#/components/schemas/CustomSegmentFilter_2' description: 'The list of filters to be combined using the filter operator. Supported filter types: - User attributes-based filters - Action-based filters (with or without attributes) - Custom segments ' UserTimezoneDetails_2: type: object description: Configuration for sending in the user's timezone. properties: send_in_user_timezone: type: boolean description: Whether to send the campaign on a specific date and time within the user's timezone. send_if_user_timezone_has_passed: type: boolean description: Whether to send the campaign if the user's timezone has passed. CampaignSearchRequest: type: object required: - request_id - limit - page properties: request_id: type: string description: A unique identifier for this search request. example: search_req_12345 campaign_fields: $ref: '#/components/schemas/CampaignSearchFields' include_child_campaigns: type: boolean description: 'Whether to include child campaigns (flow nodes and periodic children). Set to `true` to fetch details of periodic child campaigns and flow campaign nodes. Flow campaigns can be identified by the presence of `flow_id` and `flow_name` in the response. ' default: false include_archive_campaigns: type: boolean description: Whether to include archived campaigns in the results. default: false limit: type: integer description: 'The number of campaigns to display per page. **Maximum:** 15 ' minimum: 1 maximum: 15 example: 10 page: type: integer description: 'The page number to retrieve. For example, if there are 200 campaigns and the limit is 10, there will be 20 pages. ' minimum: 1 example: 1 responses: V5InternalError: description: Unhandled server-side failure. content: application/json: schema: $ref: '#/components/schemas/V5ErrorEnvelope' example: response_id: abc-101 error: code: INTERNAL_ERROR message: Internal server error. details: [] V5Unauthorized: description: Authentication failure. content: application/json: schema: $ref: '#/components/schemas/V5ErrorEnvelope' example: response_id: abc-101 error: code: UNAUTHORIZED message: Invalid or missing credentials. details: [] V5ValidationError: description: Request failed schema or component validation. content: application/json: schema: $ref: '#/components/schemas/V5ErrorEnvelope' example: response_id: abc-101 error: code: VALIDATION_FAILED message: One or more fields failed validation. request_id: req-push-001 details: - target: campaign_delivery_type message: campaign_delivery_type value is required. InternalServerError: description: Internal Server Error - Unexpected system error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: 500 Internal Server Error message: Something went wrong. Please contact Moengage team target: string details: - message: 'Expecting value: line 1 column 1 (char 0)' target: '' Unauthorized: description: Authentication Failure - Invalid or missing authentication credentials content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: 401 Authentication error message: Authentication required details: - code: InvalidValue target: APP_SECRET_KEY message: - code: InvalidValue target: APP_SECRET_KEY message: Invalid APP_SECRET_KEY is provided. request_id: '' BadRequest: description: Bad Request - Missing or invalid parameters content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: 400 Bad Request message: request_id key is mandatory field target: request_id details: - target: request_id message: request_id key is mandatory field request_id: '11' parameters: Idempotency-Key-Required: name: Idempotency-Key in: header required: true description: 'UUID v4. Required on all `POST` and `PATCH` requests except `POST /v5/campaigns/{campaign_id}/validate`. Repeating the same key returns the same response body. ' schema: type: string format: uuid X-MOE-Request-Id: name: X-MOE-Request-Id in: header required: true description: 'Correlates with `response_id`. Supply this header or `request_id` in the body; if both are set, they must match. ' schema: type: string MOE-APPKEY: name: MOE-APPKEY in: header required: true description: 'Your MoEngage Workspace ID (App ID). Find it in the dashboard at **Settings** > **Account** > **APIs** > **Workspace ID**. ' schema: type: string example: '{{workspace_id}}' MOE-APPKEY_2: name: MOE-APPKEY in: header required: true description: 'This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at **Settings** > **Account** > **APIs** > **Workspace ID (earlier app id)**. ' schema: type: string example: YOUR_WORKSPACE_ID securitySchemes: BasicAuth: type: http scheme: basic description: 'Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format ''username:password''. - **Username**: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at **Settings** > **Account** > **APIs** > **Workspace ID (earlier app id)**. - **Password**: On your MoEngage workspace, navigate to **Settings** → **Account** → **API keys** and click **Create new key**. The tab lists every API surface (Data, Segmentation, Push, Email, Campaigns, Templates, and more) and exposes per-resource actions. For Campaigns, ensure the **View**, **Create & Manage**, and **Create, Manage & Publish** checkboxes are selected. For more information on authentication and getting your credentials, refer to [Getting your credentials](/api/introduction#getting-your-credentials). Send the value in the `Authorization` header as `Basic` followed by Base64-encoding of `appkey:apisecret` (workspace ID and API key). ' x-refined-from: - moengage-campaign-draft-openapi.yml - moengage-campaigns-openapi.yml