ADDEDIT BLACKLIST API V1
Updated on 2015-03-25
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP
Summary:
Returns "Blacklist ### Created" or "Blacklist ### Updated"
Resource/WSDL Page:
http://<your_domain_here>/api/1/addedit.asmx?op=Blacklist
Parameters
| api_key Required Type: STRING Length (Max/Min): 50 |
Must be a valid API key (existing and NOT expired) Example Values: Fo35NRAqvFLXoZxqB4aVMhh |
| affiliate_id Required Type: INT Length (Max/Min): NA |
Should always be passed since the Affiliate is always part of the blacklisting Example Values: 1234 |
sub_id |
Blank to skip Example Values: asd123 |
| advertiser_id Required Type: INT Length (Max/Min): 50 |
0 to skip (can only skip if offer_id is passed) Example Values: 123456 |
| offer_id Required Type: INT Length (Max/Min): NA |
0 to skip or 0 for all offers (can only set to all offers if advertiser_id is passed) Example Values: 1 |
| blacklist_id Required Type: INT Length (Max/Min): NA |
0 to create. Blacklist ID to edit Example Values: 12 |
| blacklist_reason_id Required Type: INT Length (Max/Min): 15 |
See GET BlacklistReasons API V1 Example Values: 1, 2 |
| redirect_type Required Type: ENUM Length (Max/Min): 100 |
Where to send blacklisted traffic Example Values: redirect_404, offer_redirect, global_redirect |
| blacklist_date Required Type: DATETIME Length (Max/Min): NA |
Effective date of blacklist. A date should always be passed. Use the blacklist_date_modification_type option = do_not_change to skip this field on edit mm-dd-yyyy Example Values: 01-28-2015 |
| blacklist_date_modification_type Required Type: ENUM Length (Max/Min): NA |
Example Values: do_not_change, change |
**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value).
Example Request
| GET |
demo.cakemarketing.com/api/1/addedit.asmx/Blacklist?api_key=ej7Cjys7pnJzSiMzsgzyth1u3d7PdXn&affiliate_id=6003&sub_id=&advertiser_id=0&offer_id=1002139&blacklist_id=267&blacklist_reason_id=6&redirect_type=offer_redirect&blacklist_date=01-28-2015&blacklist_date_modification_type=change |
Sample XML Response:
<blacklist_addedit_response><success>true</success><message>Blacklist (267) Updated</message></blacklist_addedit_response>
Example Error Messages:
| Error Message |
Likely Cause |
| Invalid API Key |
API key does not exist or is expired |