« Back to Documentation Overview

delete_campaign_blacklist

Section: Blacklists
Version: 1.5.0


Delete blacklist mask on campaign level.
Conditions:

  • campaign (mandatory) – CAMPAIGN_ID.
  • mask (mandatory) – Mask to remove from blacklist
Formats of mask can be:
  • whole email – xxx@yyy.zz
  • local part of email- xxx@
  • host part of email – @yyy.zz
  • MD5 hash of email – d6dba89e8479a7049d2d7b2e5b6528ec
  • ISP name – #yahoo (note the # on the beginning)
  • IP address – 1.2.33.44 (IPv4 format only)


Parameters
stringAPI_KEY
object
stringcampaignCAMPAIGN_ID
stringmaskmask_value
Return Value
integerdeleted1

Example Request JSON

[
    "API_KEY",
    {
        "campaign": "CAMPAIGN_ID",
        "mask": "mask_value"
    }
]

Example Response JSON

{
    "deleted": 1
}

Example Error Response JSON

{
    "code": -1,
    "message": "Missing mask"
}
Method-specific Errors
Missing campaign
Invalid mask syntax
Missing mask
API-wide Errors
API key verification failed API key verification failed
API client IP not allowed API client IP not allowed
Invalid params Attribute params must be reference to hash