TRACK Update Conversion Revenue API

Updated on 2014-4-14
Current Version: Version 1
Deprecated Version: N/A
Requests Allowed: GET/SOAP

 

Summary:

Enables the update of a specific conversion based upon a Request ID passed in.

 

Resource/WSDL Page:

http://yourdomainhere/api/1/track.asmx?op=UpdateConversionRevenue

 

Parameters

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

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

Example Values: Fo35NRAqvFLXoZxqB4aVMhh

request_id
Required
Type: INTEGER
Length (Max/Min): N/A

Request ID associated with the conversion to be updated.

Example Values: 123456 

offer_id
Required
Type: INTEGER
Length (Max/Min): N/A

Offer ID related to the conversion.

Example Values: 123456

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

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/UpdateConversionRevenue?
api_key=dNJFmId9rI&request_id=3420071&offer_id=1000610
&add_to_existing=TRUE&amount=15.00&mark_as_returned=FALSE
&note_to_append=Here+is+where+I'm+putting+my+notes

 

Sample XML Response:

<string xmlns="http://cakemarketing.com/api/1/">Success - New Revenue: $45.00</string>

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired