TRACK UpdateLeadPrice API V1

Updated on 2014-04-07
Current Version: 2
Deprecated Version: 
Requests Allowed: GET & SOAP

 

Summary:

Changing the price paid to an affiliate for a lead sold to a buyer.

Open Lead card and chick the Change Price button?

 

Resource/WSDL Page:

http://<your_domain_here>/api/1/track.asmx?op=UpdateLeadPrice


 

Parameters

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

This api_key must be a valid API key (exisiting and NOT expired). You can obtain this api_key from within CAKE >> Setup >> Permissions in the API Key list.  

Example Value: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

vertical_id
Required
Type: INT
Length (Max/Min): Short

CAKE Vertical ID

Example
Value: 123

lead_id
Required
Type: STRING
Length (Max/Min): N/A

CAKE Lead ID

Example
Value: A123N4

add_to_existing
Required
Type: BOOL
Length (Max/Min): N/A

Add Amount to Existing Revenue? ["TRUE" = Add, "FALSE" = Overwrite]

Example Value: TRUE

amount
Required
Type: DECIMAL
Length (Max/Min): N/A

Revenue to be Added/Overwritten [Use a negative Dollar Amount to Remove Credit]

Example Value: -123.45

mark_as_returned
Required
Type: BOOL
Length (Max/Min): N/A

Mark the Conversion as Returned? ["TRUE", "FALSE"]

Example Value: TRUE

note_to_append
Required
Type: STRING
Length (Max/Min): N/A
Freeform Notes

billing_option
Required
Type: STRING
Length (Max/Min): N/A

Apply Price Changes to which Bill? ["ignore_billing", "next_generated_bill", "latest_generated_bill"]

Example Value: latest_generated_bill

 **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/track.asmx/UpdateLeadPrice?api_key=dNJFmId9rI&vertical_id=1&lead_id=F0E41C8D&add_to_existing=TRUE&amount=15.00&mark_as_returned=FALSE&note_to_append=Here+is+where+I'm+putting+my+notes&billing_option=next_generated_bill

 

Sample XML Response:

<update_lead_price_response>
  <success>true</success>
  <message>Lead Updated</message>
</update_lead_price_response>

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired