Skip to main content
PATCH
/
v5
/
campaigns
/
{campaign_id}
/
status
curl --request PATCH \
  --url https://api-{dc}.moengage.com/v5/campaigns/{campaign_id}/status \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-MOE-Request-Id: <x-moe-request-id>' \
  --data '
{
  "request_id": "{{request_id}}",
  "action": "STOP"
}
'
{
  "response_id": "abc-601",
  "type": "campaign",
  "data": {
    "id": "64a1b2c3d4e5f6a7b8c9d0e1",
    "action": "STOP"
  }
}
PUBLISH is not accepted on this endpoint. To publish a draft, use PATCH /v5/campaigns/{campaign_id} with { "status": "PUBLISH" }.
The response does not include the resulting campaign status. To confirm the new state after a transition, call GET /v5/campaigns/{campaign_id}.

​
Rate Limits

Rate Limit NameRate Limit
change campaign status per secondThe total number of change campaign status requests per second per client is 10.
change campaign status per minuteThe total number of change campaign status requests per minute per client allowed is 100.
change campaign status per hourThe total number of change campaign status requests per hour per client allowed is 6000.
Notes
  • Breaching the limits will reject the request.
  • Per-hour and per-day limits use a rolling window of the last 1 hour and last 24 hours respectively.

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: On your MoEngage workspace, navigate to Settings → Account → API keys and click Create new key. The tab lists every API surface (Data, Segmentation, Push, Email, Campaigns, Templates, and more) and exposes per-resource actions. For Campaigns, ensure the View, Create & Manage, and Create, Manage & Publish checkboxes are selected.

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

Send the value in the Authorization header as Basic followed by Base64-encoding of appkey:apisecret (workspace ID and API key).

Headers

​
X-MOE-Tenant-ID
string

Workspace tenant ID. Set this to the workspace (App) ID from Settings > Account > APIs > Workspace ID.

This header is optional. When omitted, the API resolves the workspace from the Basic Auth credentials in the Authorization header.

In the V1 Campaigns API, the workspace ID was passed via the MOE-APPKEY request header. In V5, this header is renamed to X-MOE-Tenant-ID.

​
X-MOE-Request-Id
string
required

Correlates with response_id. Supply this header or request_id in the body; if both are set, they must match.

​
Idempotency-Key
string<uuid>
required

UUID v4. Required on all POST and PATCH requests except POST /v5/campaigns/{campaign_id}/validate. Repeating the same key returns the same response body.

Path Parameters

​
campaign_id
string
required

Raw 24-char ObjectId of the published campaign to transition.

Body

application/json

Send campaign status change request with action.

Changes the status of a single published campaign. One campaign ID per request.

​
action
enum<string>
required

Lifecycle action for an already published or scheduled campaign.

Each action applies only to specific delivery types and requires the campaign to be in a valid source state:

ActionSupported delivery typesValid source states
STOPONE_TIMEACTIVE, SCHEDULED, PAUSED, SENDING
PAUSEPERIODIC, EVENT_TRIGGEREDACTIVE, SCHEDULED, SENDING
RESUMEPERIODIC, EVENT_TRIGGEREDPAUSED
`STOP` cannot be used on Periodic campaigns. `PAUSE` and `RESUME` cannot be used on One-time campaigns.
Available options:
STOP,
PAUSE,
RESUME
​
request_id
string

A unique identifier for this status change request.

Response

Transition accepted.

​
response_id
string
​
type
string
Example:

"campaign"

​
data
object

Returned after a successful status transition on a published campaign.