Delete Campaigns API

This API is used to get the campaign details..

📘

Know your endpoint

Based on the domain you use to log in to Webex Campaign, the endpoint domain for your API varies. For more information, refer to the Know Your API Endpoints section.

Headers

The following table describes the request headers:

Request HeaderDescription
content-typeapplication/json
authorizationAccess token or API Secret Key in Bearer format

Example: Bearer $(key)

Request Example



https://yourapihubdomain.io/v1/campaigns/16663731580000

Response Parameters

This API will return the following response parameters:

ParameterDescription
nameReturns the name of the campaign
idReturns the id of the campaign
messageReturns the the confirmation message.

Response Example

{
    "id": "16663731580000",
    "name": "Sample_Campaign",
    "message": "campaign deleted successfully."
}



Failure Response Codes

The API will return code within the response as per the following table in case of failure scenarios.

HTTP Status CodeCode within API ResponseDescription
400400I/O error on post request. Cannot retry due to server authentication, in streaming mode.
400400Failed to delete the selected campaign, as it contains deployments.
401430Authorization failed. This resource is not allowed to access using this TOKEN or KEY
401498Invalid token or Access token expired
404404Not found
405405Method not supported
500500Internal server error
Language