TRACK UpdateConversion API Version 2

Updated on 2014-08-20
Current Version: Version 2
Deprecated Version: V1
Requests Allowed: GET&SOAP


Summary:

Returns a message indicating whether or not the conversion was updated. 


Resource/WSDL Page:

http:<your_domain_here>/api/2/track.asmx?op=UpdateConversion


Parameters

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

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

Example Values: Fo35NRAqvFLXoZxqB4aVMhh

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

Must be an existing offer ID

Example Values: 123456

conversion_id
Required - OR request_session_id OR transaction_id
Type: INT
Length (Max/Min): NA

Must be an existing Conversion ID. Required if request_session_id OR transaction_id are not present

{Seereports.asmx > Conversions}

Example Values: 123456

request_session_id
Required - OR conversion_id OR transaction_id
Type: INT
Length (Max/Min): NA

Click Request Session ID. Required if either conversion_id OR transaction_id are not present

{See export.asmx > Conversions}

Example Values: 123456

 

transaction_id
Required - OR conversion ID OR request_session_id
Type: STRING
Length (Max/Min): NA

Conversion Transaction ID. Required if either conversion_id OR request_session_id are not present. Use REPORTS Conversions API

[To ignore this string field, you can leave it blank]

Example Values: abc123

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


Payout Amount

Example Values: 10.50

 

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


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

Example Values: FALSE

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


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

Example Values: -123.45

received_option
Required
Type: ENUMERATION
Length (Max/Min): NA


How should the received field be handled with this request?

Example Values: total_sale_amount or additional_sale_amount or total_revenue or additional_revenue or no_change

disposition_type
Required
Type: ENUMERATION
Length (Max/Min): NA


Disposition Type to assign to the conversion

Example Values: no_change or pending or rejected or approved or returned

disposition_id
Required Value
Type: INT
Length (Max/Min): NA

Disposition for Conversions. Use AcceptedDispositions API or RejectedDispositions API depending on the value passed in disposition_type

Example Values: 25, 75, 3

update_revshare_payout
Required
Type: BOOL
Length 9Max/Min): NA


When the conversion is tied to a revshare campaign, do you want the received amount to update the payout amount

Example Values: FALSE

effective_date_option
Required
Type: ENUMERATION
Length (Max/Min): NA

The effective date these changes should be applied to.

Accepts "today", "conversion_date" or "custom"

Example Values: today

custom_date
Required
Type: DATETIME
Length (Max/Min): NA

Must contain a date. This date field is only used on effective_date_option = custom, otherwise this date is ignored. 

Allowed formats: MM/DD/YYYY HH:MM:SS

Example Values: 2014-0424

note_to_append
Optional
Type: STRING
Length (Max/Min): NA


Freeform Notes.  Can be left blank.

Example Values: notes to append

 **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/2/track.asmx/UpdateConversion?api_key=rYwtD48irQ0CiHRiuaB9abASO3e8O7GS&offer_id=55378625&conversion_id=839659&
request_session_id=4062673&transaction_id=&payout=10.50&add_to_existing_payout=TRUE&received=-12.50&received_option=no_change&disposition_type=no_change&disposition_id=3&update_revshare_payout=FALSE&effective_date_option=today&custom_date=2014/08/20&note_to_append=timtimtim


Sample XML Response:

  

<update_conversion_response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://cakemarketing.com/api/1/">
<success>true</success>
<message>Conversion Updated</message>
</update_conversion_response>



Example Error Messages:  

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired