> ## Documentation Index
> Fetch the complete documentation index at: https://moengage-sdk-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Change Campaign Status

> Updates the status of campaigns to stop, pause, or resume them.


**Supported Actions**

* **STOP**: Stop a scheduled One-time campaign
* **PAUSE**: Pause a running Periodic or Event-triggered campaign
* **RESUME**: Resume a paused Periodic or Event-triggered campaign

**Supported Channels**

* **Email**: Pause and resume Periodic or Event-triggered campaigns
* **Push**: Pause and resume the following campaign types:
  * Periodic
  * Event-triggered
  * Device-triggered
  * Location-triggered

<Info>
  **Important Information**

  * You can only change the status of campaigns created via the API (not Dashboard-created campaigns)
  * Maximum 10 campaign IDs can be processed per request
  * STOP action only works for **scheduled** One-time campaigns
  * Once a One-time campaign moves to Active state, it cannot be stopped
</Info>

<Warning>
  **Action Restrictions**

  * **STOP**: Only for scheduled One-time campaigns
  * **PAUSE**: Only for Periodic and Event-triggered campaigns
  * **RESUME**: Only for paused Periodic and Event-triggered campaigns
  * Periodic campaigns do NOT support STOP action
</Warning>


## OpenAPI

````yaml /api/campaigns/campaigns.yaml post /campaigns/status
openapi: 3.0.3
info:
  title: MoEngage Campaigns API
  version: '2025-11-20'
  description: >
    The MoEngage Campaigns API allows you to create and manage Push and Email
    campaigns programmatically.


    **Supported Channels:**

    - Push (Android, iOS, Web)

    - Email


    **Supported Delivery Types:**

    - ONE_TIME

    - PERIODIC

    - EVENT_TRIGGERED

    - BUSINESS_EVENT_TRIGGERED

    - DEVICE_TRIGGERED (Push only)

    - LOCATION_TRIGGERED (Push only)

    - BROADCAST_LIVE_ACTIVITY (Push iOS only)


    **Rate Limits:** 5 campaigns per minute, 25 campaigns per hour, 100
    campaigns per day.


    <Info>

    If this API is not enabled for your account, contact your MoEngage Customer
    Success Manager (CSM) or the Support team to request enablement.

    </Info>


    For more details, visit [MoEngage Developer
    Documentation](https://developers.moengage.com).
  contact:
    name: MoEngage Developer Team
    email: support@moengage.com
    url: https://developers.moengage.com
servers:
  - url: https://api-{dc}.moengage.com/core-services/v1
    description: MoEngage Campaigns API Server
    variables:
      dc:
        default: '01'
        description: >-
          Your MoEngage Data Center (DC). Can be 01, 02, 03, etc. Find your data
          center number on the MoEngage Data Centers page.
        enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          - '06'
security:
  - BasicAuth: []
paths:
  /campaigns/status:
    post:
      tags:
        - Update Campaigns
      summary: Change Campaign Status
      description: |
        Updates the status of campaigns to stop, pause, or resume them.
      operationId: change_campaign_status
      parameters:
        - $ref: '#/components/parameters/MOE-APPKEY'
      requestBody:
        description: Campaign status change request with action and campaign IDs.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignStatusChangeRequest'
            examples:
              pause_campaign:
                summary: Pause Campaign
                value:
                  request_id: status_change_pause
                  action: PAUSE
                  campaign_ids:
                    - camp_periodic_123
              resume_campaign:
                summary: Resume Campaign
                value:
                  request_id: status_change_resume
                  action: RESUME
                  campaign_ids:
                    - camp_periodic_123
              stop_campaign:
                summary: Stop Scheduled Campaign
                value:
                  request_id: status_change_stop
                  action: STOP
                  campaign_ids:
                    - camp_onetime_456
              batch_pause:
                summary: Pause Multiple Campaigns
                value:
                  request_id: status_batch_pause
                  action: PAUSE
                  campaign_ids:
                    - camp_periodic_001
                    - camp_periodic_002
                    - camp_event_003
      responses:
        '200':
          description: |
            Campaign status changed successfully. No content returned.

            For a successful 200 response, the API does not return any content.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    MOE-APPKEY:
      name: MOE-APPKEY
      in: header
      required: true
      description: >
        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)**
      schema:
        type: string
      example: YOUR_WORKSPACE_ID
  schemas:
    CampaignStatusChangeRequest:
      type: object
      description: Request to change the status of one or more campaigns.
      required:
        - request_id
        - action
        - campaign_ids
      properties:
        request_id:
          type: string
          description: A unique identifier for this status change request.
          example: status_change_12345
        action:
          type: string
          enum:
            - STOP
            - PAUSE
            - RESUME
          description: >
            The action to perform on the campaign(s).


            - **STOP**: Stop a scheduled One-time campaign (cannot be used for
            Periodic campaigns)

            - **PAUSE**: Pause a running Periodic or Event-triggered campaign

            - **RESUME**: Resume a paused Periodic or Event-triggered campaign
        campaign_ids:
          type: array
          items:
            type: string
          description: |
            Array of campaign IDs whose status you want to change.

            **Maximum:** 10 campaign IDs per request
          minItems: 1
          maxItems: 10
          example:
            - camp_abc123
            - camp_def456
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: The error code (e.g., "400 Bad Request").
            message:
              type: string
              description: Description of why the request failed.
            target:
              type: string
              description: The target of the error.
            details:
              type: array
              items:
                type: object
                properties:
                  target:
                    type: string
                  message:
                    type: string
            request_id:
              type: string
              description: The request ID associated with this error.
  responses:
    BadRequest:
      description: Bad Request - Missing or invalid parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            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'
    Unauthorized:
      description: Authentication Failure - Invalid or missing authentication credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            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: ''
    InternalServerError:
      description: Internal Server Error - Unexpected system error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            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: ''
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >
        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

````