Update Campaign

Updates an existing Push or Email campaign in MoEngage.

PATCH /campaigns/{campaign_id}

cURL

push_update_content

curl --request PATCH \ --url https://api-{dc}.moengage.com/core-services/v1/campaigns/{campaign_id} \ --header 'Authorization: Basic <encoded-value>' \ --header 'Content-Type: application/json' \ --header 'MOE-APPKEY: <moe-appkey>' \ --data ' { "request_id": "push_update_12345", "updated_by": "[e-mail]", "campaign_content": { "content": { "push": { "android": { "template_type": "BASIC", "basic_details": { "notification_channel": "general", "title": "Updated Title - Flash Sale!", "message": "Updated Message - Only 2 hours left!", "default_click_action": "DEEPLINKING", "default_click_action_value": "https://example.com/flash-sale" } }, "ios": { "template_type": "BASIC", "basic_details": { "title": "Updated Title - Flash Sale!", "message": "Updated Message - Only 2 hours left!", "default_click_action": "DEEPLINKING", "default_click_action_value": "https://example.com/flash-sale" } } } } } } '

400

{
  "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"
  }
}

Important Information

• You can only update campaigns created via the API, not campaigns created through the MoEngage Dashboard.
• Pass only the fields you want to update. You don’t need to send the complete payload.
• If updating a field within an object, you must pass the complete object.
• Campaigns cannot be updated when in Stopped or Archived state.

Update Restrictions

For Scheduled Campaigns

• Can edit all fields except scheduling type for One-Time campaigns
• Can edit all fields except scheduling type for Periodic/Event-Triggered campaigns if no instance has been sent yet

For Active Campaigns Cannot edit the following fields:

• Trigger Condition
• Segmentation Details
• Conversion Goal Details
• Scheduling Type
• Scheduling Start Date

For Event-Triggered campaigns, updated content is cached and takes up to 30 minutes to take effect.

Authorizations

Authorization · string · header · required

Authentication is done via Basic Auth. The username is your Workspace ID (earlier APP ID) and the password is your API Key. The value is a base64 encoding of 'username:password'.

How to obtain credentials:

1. Navigate to Settings → Account → APIs in the MoEngage Dashboard
2. Username: Copy the Workspace ID (earlier app id)
3. Password: Copy the API key from the Campaign report/Business events/Custom templates tile

Headers

MOE-APPKEY · string · required

This is the workspace ID (earlier APP ID) of your MoEngage workspace.

You can find your MoEngage Workspace ID in the MoEngage Dashboard: Settings → Account → APIs → Workspace ID (earlier app id)

Path Parameters

campaign_id · string · required

The unique ID of the campaign to update.

You can fetch the campaign ID using the Get Campaign Details API by filtering with campaign name, channel, or other criteria.

Body

application/json

Campaign update payload. Only include the fields you want to update.

Note: If updating a nested field, you must pass the complete parent object. For example, to update the title of a Push notification, pass the complete campaign_content object.

Push Campaign

Email Campaign

request_id · string · required

A unique identifier for this campaign update request.

Example:

"push_update_12345"

updated_by · string<email> · required

The email ID of the user updating this campaign.

Example:

"[e-mail]"

channel · enum<string>

The communication channel (automatically set to PUSH for this tab).

Available options: PUSH

basic_details · object

Contains the basic information about the Push campaign.

Show child attributes

trigger_condition · object

Trigger condition details for Push event-triggered campaigns.

Required for EVENT_TRIGGERED campaigns.

Show child attributes

campaign_content · object

Contains the content and variations for the Push campaign.

Show child attributes

segmentation_details · object

Defines the target audience for the campaign.

Show child attributes

scheduling_details · object

Defines when the campaign should be sent.

Show child attributes

delivery_controls · object

Controls for Push campaign delivery behavior.

Show child attributes

advanced · object

Advanced campaign settings.

Show child attributes

conversion_goal_details · object

Configuration for tracking campaign conversion goals.

Show child attributes

control_group_details · object

Configuration for control groups.

Show child attributes

utm_params · object

UTM parameters for tracking campaign performance.

Show child attributes

Response

204

Campaign updated successfully. The server successfully processed the request but is not returning any content.