ADDEDIT AdvertiserCreditLimit API Version 1

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

 

Summary:

Returns "Advertiser Credit Created" or "Advertiser Credit Updated"

Resource/WSDL Page:

http://<your_domain_here>/api/1/addedit.asmx?op=AdvertiserCreditLimit

Parameters

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

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

Example Values: Fo35NRAqvFLXoZxqB4aVMhh

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

Advertiser ID {See get.asmxAdvertisers} 0 creates, > 0 edits

Example Values: 123456

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

0 to skip, used only for currency enabled clients

Example Values: 0

credit_limit
Required
Type: DECIMAL
Length (Max/Min): NA

The amount of credit allotted for digital spend

Example Values: 2.10

hard_cap
Required
Type: BOOL
Length (Max/Min): NA

Hard cap when credit limit is depleted? ["TRUE", "FALSE"]

Example Values: TRUE

 **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/AdvertiserCreditLimit?api_key=dNJFmId9rI&advertiser_id=178&currency_id=1&credit_limit=1000000&hard_cap=TRUE

 

Sample XML Response:


<advertisercreditlimit_addedit_response>
<success>true</success>
<message>Advertiser Credit Created</message>
</advertisercreditlimit_addedit_response>

Example Error Messages:  

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired

Invalid Advertiser ID

advertiser_id is 0 or is not found in the system

Invalid Currency

Currency is enabled in the client and the currency_id is > 0, but currency_id is not found in the system