Submit a Ticket My Tickets
Welcome
Login  Sign up

ADDEDIT ApplySuppressionListToOffer API Version 1

ADDEDIT ApplySuppressionListToOffer API

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

 

Summary:

Allows you to create or update a suppression list to an existing offer. 

Resource/WSDL Page:

http://yourdomainhere/api/1/addedit.asmx?op=ApplySuppressionListToOffer

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

Suppression List ID. Obtained via EXPORT Advertisers API

Example Values: 123456 

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

Offer ID. Note: Suppression list IDs are bound to Advertisers IDs, this offer_id must fall under the Advertiser who owns the suppression list.

Example Values: 123456

optizmo_mailer_access_key
Required
Type: BYTE
Length (Max/Min): NA

Optizmo Mailer Access Key.  Required only if suppression list type of the specified suppression list is optizmo.

Example Values: 0

 **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/ApplySuppressionListToOffer?api_key=dNJFmId9rI&suppression_list_id=164&offer_id=148&optizmo_mailer_access_key=

 

Sample XML Response:


<?xml version="1.0" encoding="utf-8"?>
<apply_suppression_list_to_offer_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 164 Successfully Applied to Offer 148</message>
  <row_count>0</row_count>
</apply_suppression_list_to_offer_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 or equal to 0

Invalid Offer ID

offer_id is less than or equal to 0

No Suppression List Found

could not find a suppression list for the specified suppression_list_id

 

No Offer Found

could not find an offer for the specified offer_id that is valid for the advertiser connected to the found suppression list

Invalid Optizmo Mailer Access Key

did not pass a optizmo_mailer_access_key when trying to apply an optizmo suppression list

Internal Error

issue with connecting to the ezepo api

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.