CAKE Help & Support

[Addedit] SuppressionList (V1) - Admin

Modified on: Fri, 18 Sep, 2015 at 4:46 PM


 

WSDL Page:  http://<your_domain_here>/api/1/addedit.asmx?op=SuppressionList

 

Parameter Summary:

api_key / STRING = Admin API Key {See get.asmx > GetAPIKey}

suppression_list_id / INT (unsignedByte)= Suppression List ID [Existing ID = Edit Suppression List/ "0" = Create New Suppression List] {See get.asmx > Advertisers}

advertiser_id / INT (unsignedByte)= Advertiser ID {See get.asmx > Advertisers}

list_name / STRING =Suppression List Name

stored_in_md5_only / BOOL = Is this list stored in MD5 encryption?

last_change_date / DATETIME = Date this list was last modified. Date must be passed every time. [MM/DD/YYYY HH:MM:SS]

last_change_date_modification_type / ENUMERATION = This field is used to determine how to apply the last_change_date. ["do_not_change","change","remove"]

suppression_list_type / ENUMERATION = This field is used to determine how to apply the last_change_date. ["static_link","unsubcentral","optizmo","ezepo"]

static_link_list_location / STRING = End point of where the file is hosted. Only required if you select a static_link option for suppression_list_type.

unsubcentral_api_url / STRING = Unsubcentral API URL. Only required if you select unsubcentral option for suppression_list_type.

unsubcentral_parent_hash / STRING = Unsubcentral Parent Hash. Only required if you select unsubcentral option for suppression_list_type.


 

 

Parameter Types:

api_key - ID    

suppression_list_id - ID    

advertiser_id - ID    

list_name - ASSIGNABLE    

stored_in_md5_only - ASSIGNABLE    

last_change_date - ASSIGNABLE  
 
last_change_date_modification_type - ASSIGNABLE    

suppression_list_type - ASSIGNABLE  
 
static_link_list_location - ASSIGNABLE    

unsubcentral_api_url - ASSIGNABLE    

unsubcentral_parent_hash - ASSIGNABLE

 

 

Sample GET Call:

http://demo.cakemarketing.com/api/1/addedit.asmx/SuppressionList?api_key=dNJFmId9rI&suppression_list_id=0&advertiser_id=2&list_name=My+Suppression+List+Name&stored_in_md5_only=False&last_change_date=1%2F1%2F2001&last_change_date_modification_type=do_not_change&suppression_list_type=static_link&static_link_list_location=http%3A%2F%2Fmydomain.com%2Femail%2Fcompliance%2Flistname.php&unsubcentral_api_url=&unsubcentral_parent_hash=

 

Sample XML Response:

<?xml version="1.0" encoding="utf-8"?>
<suppression_list_addedit_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/1/">
  <success>true</success>
  <message>Suppression List 162 Successfully Created</message>
  <row_count>0</row_count>
</suppression_list_addedit_response>


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.
Login
New support ticket Check ticket status