Delete Campaign API

Learn to delete email campaign with Delete Campaign API.

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:

Request Headers

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

Header NameTypeDescriptionExampleRequired?
api-keyStringAPI key for authentication41a1de35948f915f64907ced9eed4f00Yes

Request Body

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

ParameterData TypeDescriptionRequired?
campaign_idIntegerThe unique identifier of the campaign to be deleted.Yes
callback_detailsObjectObject specifying callback information. This includes: body, header, method, and endpoint.No
endpointStringEndpoint for making the callback. Ensure that the endpoint is always an HTTPS endpointNo
methodStringMethod of callback like POST, GET, PATCH, PUT, DELETE, and so on.No
headerArray of objectTo specify header detail for the callback: Content-Type and Authorization.No
bodyArray(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
channelStringThe 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 CodeDescription
400The request parameters are invalid.
401Authentication failed due to an invalid API key.
500An error occurred on the server side.