Create Campaign Draft

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.

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.

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, iOS push content, or Web push content.

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.

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.

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.

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.

Configuration for tracking campaign conversion goals.

For runnable single-goal and multi-goal examples, refer to Conversion goal tracking.

Configuration for control groups.

For runnable campaign-control-group and global-control-group examples, refer to Control groups.

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.

Configuration for capping the number of users a campaign can reach (max-send).

For runnable TOTAL (lifetime cap), INSTANCE (per-send cap, Periodic Push only), and disabled-cap examples, refer to Campaign audience cap.

Supported channels: Email, Push.

Supported delivery types:

• All delivery types support frequency: TOTAL (lifetime cap).
• frequency: INSTANCE (per-send cap) is supported only for Periodic Push campaigns.
• campaign_audience_limit is not supported for BROADCAST_LIVE_ACTIVITY.

Flag-gated feature: This feature is not enabled by default for any workspace and requires explicit activation by your MoEngage account team. If you include campaign_audience_limit in a request on a workspace where the flag has not been enabled, the API returns a 400 with the following error body:

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "Campaign Audience Limit feature is not enabled for this db",
    "target": "campaign_audience_limit",
    "details": [
      {
        "target": "campaign_audience_limit",
        "message": "Campaign Audience Limit feature is not enabled for this db"
      }
    ]
  },
  "response_id": "{{response_id}}"
}

When is_campaign_audience_limit_enabled is true, the fields metric, frequency, and limit are all required. When set to false, those three fields must not be provided.

For 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. Passing them for a ONE_TIME campaign causes the validate API to fail.