This API allows you to suspend an active email campaigns from the Netcore CE platform. Suspending a campaign stops its execution until it is resumed or canceled.

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/suspend
United States	https://api.netcoresmartech.com/v4/campaign/suspend
Europe	https://apieu.netcoresmartech.com/v4/campaign/suspend

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.

Parameter	Data Type	Description	Required?
`campaign_ids`	Array of Integer	The unique identifier of the campaign to be deleted.	Yes
`channel`	String	The channel of the campaign being deleted. In this case, it should be email. Note that once the campaign has been sent completely, you won't be able to suspend. It's only when the campaign is in "running" or in "scheduled" state is when the suspend operation becomes successful.	No

Example Request Body

{
  "channel": "email",
  "campaign_ids": [
    239
  ]
}

Response

Success Response: 200 OK

Successfully deleted the campaign.

Success Example Response

{
  "data": {
    "status": "success",
    "description": "The number of campaigns successfully suspended are 1 and the following Campaign IDs are affected: [428]"
  },
  "message": "success",
  "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.