This API allows you to test an email campaign by sending it to specified test users. This helps in verifying the content, formatting, and delivery of the campaign before it is sent to the actual audience.

HTTP Method

This API uses the POST method to fetch existing email campaigns.

API Endpoint

The List Campaign API is available across multiple regions; below are the base URLs for different regions:

Region	Base URL
India	https://apiind.netcoresmartech.com/v4/campaign/test
United States	https://api.netcoresmartech.com/v4/campaign/test
Europe	https://apieu.netcoresmartech.com/v4/campaign/test

Request Headers

Authentication details are required to access the API. Ensure you include the necessary tokens or credentials in your request headers.

Header Name	Type	Description	Example	Required?
`api-key`	String	API key for authentication	`41a1de35948f915f64907ced9eed4f00`	Yes

Request Body

All necessary parameters should be passed in the request body in JSON format.

Parameters

Name	Data Type	Description	Required?
`test_campaign_details`	Array[Object]	Contains the details of the test campaign.	Yes
`channel`	String	The channel of the campaign being tested. For example: `"email"`	Yes
`campaign_id`	Integer	The ID of the campaign to be tested.	Yes
`test_user_details`	Object	Object containing the details of the test users. This includes: `email_ids`.	Yes
`email_ids`	Array	Email addresses to send the test campaign to.

Example Request Body

{
  "test_campaign_details": [
    {
      "channel": "email",
      "campaign_id": 1231,
      "test_user_details": {
        "email_ids": [
          "[email protected]"
        ]
      }
    }
  ]
}

Response

Success Response: 200 OK

Successfully deleted the campaign.

Success Example Response

{
  "data": {
    "status": "string",
    "description": "string"
  },
  "message": "string",
  "statusCode": 200
}

Error Code

Error Code	Description
400	The request parameters are invalid.
401	Authentication failed due to an invalid API key.
500	An error occurred on the server side.