Change Campaign Status

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

Authorizations

Authorization

string

header

required

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: Use your API Key, which you can find within the Campaign report/Business events/Custom templates/Catalog API/Inform Report tile.

For more information on authentication and getting your credentials, refer here.

Headers

MOE-APPKEY

string

required

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).

Body

application/json

Send campaign status change request with action and campaign IDs.

You can request to change the status of one or more campaigns.

request_id

string

required

A unique identifier for this status change request.

Example:

"status_change_12345"

action

enum<string>

required

The action to perform on the campaign(s).

STOP: Stop a scheduled One-time campaign (cannot be used for Periodic campaigns). After a One-time campaign moves to Active state, it cannot be stopped.
PAUSE: Pause a running Periodic or Event-triggered campaign.
RESUME: Resume a paused Periodic or Event-triggered campaign.

Available options:

STOP,

PAUSE,

RESUME

campaign_ids

string[]

required

Array of campaign IDs whose status you want to change.

Maximum: 10 campaign IDs per request

Required array length: 1 - 10 elements

Example:

["camp_abc123", "camp_def456"]

Response

Campaign status changed successfully. No content returned.

For a successful 200 response, the API does not return any content.