Delete Push/Message Center Campaign
Use this interface to delete an existing push or message center campaign object.
A successful response returns a 200 OK response. The response body will indicate the name of the campaign that was deleted.
Note: The Responsys Advanced API is generally available for all Responsys customers.
Service URL:
/rest/api/push/v1.3/campaigns/{campaignName}
Required Path Parameters:
campaignName - Name of the campaign to be deleted.
Request Method:
DELETE
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body - Required Properties:
Not applicable
Sample Request Body
Not applicable
Sample Response Body - Success
{
"message": "Campaign [ Push_Campaign_to_Delete ] deleted successfully",
"status": true
}
Sample Response Body - Failure
400 Bad Request
Invalid campaign type: Requests fail if the campaign specified in the request is not a SMS campaign. The error resembles:
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "Invalid Campaign Type.",
"errorDetails": []
}
404 Not Found
Campaign not found: If the campaign name specified cannot be found or is invalid, the error will resemble the following:
{
"type": "",
"title": "Campaign not found",
"errorCode": "CAMPAIGN_NOT_FOUND",
"detail": "Campaign not found",
"errorDetails": []
}