ADDEDIT Suppression List API Version 1

Updated on 2014-05-01
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP
 


Summary:

Allows you to create or update Suppression List in CAKE.


Resource/WSDL Page:

http://YOURDOMAIN.com/api/1/addedit.asmx?op=SuppressionList


Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

Must be a valid API Key (existing and NOT expired)

Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

suppression_list_id
Required
Type: INT
Length (Max/Min): NA

0 to create. Obtained via EXPORT Advertisers API

Example Values:  0

 

advertiser_id
Required
Type: INT
Length (Max/Min): NA

Obtained via GET Advertisers API

Example Values: 1234

list_name
Required
Type: STRING
Length (Max/Min): 50


Example Values: Optout list

stored_in_md5_only
Required
Type: BOOL
length (Max/Min): NA


Example Values: True, False

last_change_date
Required
Type: DATETIME
length (Max/Min): NA

Must pass a date. Use in conjunction with last_change_modification_type field below

Example Values: 12/20/2016

last_change_modification_type
Required
Type: modification_types
length (Max/Min): NA


Example Values: do_not_change, change, remove

suppression_list_type
Required
Type: suppression_list_types
length (Max/Min): NA


Example Values: static_link, unsubcentral, optizmo, ezepo

static_link_list_location
Required
Type: STRING
length (Max/Min): 255

Required if suppression_list_type equals static_link

Example Values: http://www.linklocation.com

unsubcentral_api_url
Required
Type: STRING
length (Max/Min): 50

Required if suppression_list_type equals unsubcentral

Example Values: Http://www.unsibcentralurl.com

unsubcentral_parent_hash
Required
Type: STRING
length (Max/Min): 150

Required if suppression_list_type equals unsubcentral

 **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

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>


 

Example Error Messages:  

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired

Invalid Suppression List ID

suppression_list_id is less than zero

Invalid Advertiser ID

no advertiser found for the specified advertiser_id

Invalid List Name

list_name is NULL or empty

Invalid Static Link List Location

suppression_list_type equals static_link and static_link_location is NULL or empty

Invalid UnsubCentral API URL

suppression_list_type equals unsubcentral and unsubcentral_api_url is NULL or empty

Invalid UnsubCentral Parent Hash

suppression_list_type equals unsubcentral and unsubcentral_parent_hash is NULL or empty

No Suppression List Found

no suppression List found for the specified suppression_list_id