This API allows you to delete an existing email campaigns from the Netcore CE platform. This API provides a way to remove campaigns that are no longer needed.

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

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_id`	Integer	The unique identifier of the campaign to be deleted.	Yes
`callback_details`	Object	Object specifying callback information. This includes: body, header, method, and endpoint.	No
`endpoint`	String	Endpoint for making the callback. Ensure that the endpoint is always an HTTPS endpoint	No
`method`	String	Method of callback like POST, GET, PATCH, PUT, DELETE, and so on.	No
`header`	Array of object	To specify header detail for the callback: `Content-Type` and `Authorization`.	No
`body`	Array(Object)	Specify details in the body of the callback. Note: In order to pass any dynmaic values related to campaign specify them under double braces {{}}	No
`channel`	String	The channel of the campaign being deleted. In this case, it should be email.	Yes

Example Request Body

{
  "campaign_details": [
    {
      "channel": "email",
      "campaign_id": 828
    }
  ]
}

Responses

Success Response: 200 OK

Successfully deleted the campaign.

Example Response

{
  "data": {
    "id": 425,
    "status": "success",
    "description": "Deletion completed successfully. The callback action executed successfully."
  },
  "message": "Deletion completed successfully. The callback action executed successfully.",
  "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.