ADDEDIT CampaignSubIdExceptions API Version 1

Updated on 07/18/2017
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP

 

Summary:

This service was created to complete the CAKE API library. This service supports Adding, and Editing Campaign level exceptions. Allowing the users to manage, SubIds exceptions by specifying whether the inputs are blocked or allowed.

 

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


Parameters

api_key
Required
Type: STRING
Max Length: 50 Char.
Must be a valid API key (existing and Not expired)
Example Values: Fo35NRAqvFLXoZxqB4aVMhh
campaign_id
Required
Type: INTEGER
Max Length: N/A
Campaign ID will specify whether this is a BLOCK or ALLOW
Example Values: 123
sub_id
Required
Type: INTEGER
Max Length: N/A
CAKE Sub ID displayed on the Admin Portal
Example Values: 456


sub_id_exception_type
Required
Type: ENUM
Max Length: N/A
Accepts "allow" or "block"
If allow is passed and the Campaign ID is Original, allows are not allowed.
Example Values: allow
sub_id_modification_type
Required
Type: ENUM
Max Length: N/A
Accpets "add" or "replace" or remove"
Example Values: replace


**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-new.cakemarketing.com/api/1/addedit.asmx/CampaignSubIdExceptions?api_key=BETwue0XUuMnZitzyqzddodKbz08h7&campaign_id=49703&sub_id=cktst10&sub_id_exception_type=block&sub_id_modification_type=replace


Sample XML Response:

<?xml version="1.0" encoding="UTF-8"?>
<campaign_exceptions_response>
   <success>true</success>
   <row_count>1</row_count>
   <message>SubID Exceptions Updated for Campaign ID (501)</message>
</campaign_exceptions_response>