MOmoengage
Update Campaigns

Change Campaign Status

This API updates the status of campaigns to stop, pause, or resume them. You can only change the status of campaigns created via the Create Campaign API (not dashboard-created campaigns).

post/campaigns/status

Request

Headers

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

Request body

request_idstring required

A unique identifier for this status change request.

action'STOP' | 'PAUSE' | 'RESUME' 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. PAUSE is not supported for BUSINESS_EVENT_TRIGGERED, DEVICE_TRIGGERED, or LOCATION_TRIGGERED campaigns.
  • RESUME: Resume a paused Periodic or Event-triggered campaign. RESUME is not supported for BUSINESS_EVENT_TRIGGERED, DEVICE_TRIGGERED, or LOCATION_TRIGGERED campaigns.
campaign_idsstring[] required

Array of campaign IDs whose status you want to change.

Maximum: 10 campaign IDs per request

Example request

{
  "request_id": "status_change_12345",
  "campaign_ids": [
    "camp_abc123",
    "camp_def456"
  ]
}

Response

Campaign status changed successfully. No content returned.

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

Changes

No recorded changes to this operation across all 1 revision of this API.