Test Campaigns

Test Campaign

This API sends a test Push or Email campaign to specific users or identifiers before launching it to your entire audience. You can only test campaigns created via the API, not campaigns created through the MoEngage dashboard.

post/campaigns/test

Request

Base URL
https://api-01.moengage.com/core-services/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/moengage/apis/moengage-campaigns-api/docs/campaigns/test/post.ts
A function with typed inputs. Its response is checked against the schema.

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

MOE-PROJECT-CODEstring

This is the project ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > Portfolio > Project ID. Note: This parameter is mandatory for workspaces with the Portfolio feature enabled.

Request body

Response

Test campaign sent successfully

dataobject

Object containing test results for each identifier.

Each key is an identifier value with its delivery status.

messagestring

A success message.

Example response

{
  "data": {
    "user_12345": {
      "status": "success"
    },
    "user_67890": {
      "status": "failed",
      "failure_reason": "User not found"
    }
  },
  "message": "Test campaign created successfully"
}

Changes

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