{
"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"
}
}{
"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": ""
}
}{
"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": ""
}
]
}
}Update Campaign
Updates an existing Push or Email campaign in MoEngage.
{
"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"
}
}{
"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": ""
}
}{
"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": ""
}
]
}
}- 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.
- 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
- Trigger Condition
- Segmentation Details
- Conversion Goal Details
- Scheduling Type
- Scheduling Start Date
Authorizations
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:
- Navigate to Settings → Account → APIs in the MoEngage Dashboard
- Username: Copy the Workspace ID (earlier app id)
- Password: Copy the API key from the Campaign report/Business events/Custom templates tile
Headers
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
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
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
A unique identifier for this campaign update request.
"push_update_12345"
The email ID of the user updating this campaign.
"john.doe@example.com"
The communication channel (automatically set to PUSH for this tab).
PUSH Contains the basic information about the Push campaign.
Show child attributes
Show child attributes
Trigger condition details for Push event-triggered campaigns.
Required for EVENT_TRIGGERED campaigns.
Show child attributes
Show child attributes
Contains the content and variations for the Push campaign.
Show child attributes
Show child attributes
Defines the target audience for the campaign.
Show child attributes
Show child attributes
Defines when the campaign should be sent.
Show child attributes
Show child attributes
Controls for Push campaign delivery behavior.
Show child attributes
Show child attributes
Advanced campaign settings.
Show child attributes
Show child attributes
Configuration for tracking campaign conversion goals.
Show child attributes
Show child attributes
Configuration for control groups.
Show child attributes
Show child attributes
UTM parameters for tracking campaign performance.
Show child attributes
Show child attributes
Response
Campaign updated successfully. The server successfully processed the request but is not returning any content.
Was this page helpful?