Submit a Ticket My Tickets
Welcome
Login  Sign up

TRACK UpdateConversion API Version 4

TRACK UpdateConversion API Version 4

Updated on 2015-06-02
Current Version: Version 4
Deprecated Version: V1, V2, V3

Requests Allowed: GET/SOAP/POST


Summary:

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


Resource/WSDL Page:

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


Parameters

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

Must be a valid API key (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. 

Pass 0 if using request_session_id or transaction_id

Pass 0 if using request_session_id or transaction_id

Example Values: 123456

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

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

Pass 0 if using conversion_id or transaction_id. 

*Note: If updating an event, you must use conversion_id or transaction_id. Request_session_id can only be used to update conversions.

Example Values: 123456

transaction_id
Required
Type: STRING
Length (Max/Min): NA

Conversion Transaction ID. Required if either conversion_id OR request_session_id are not present. 

Pass as blank if using conversion_id or request_session_id

{Seereports.asmx > Conversions}


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

Not currently available in the user interface. Can be obtained with the AcceptedDispositions API.

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
Required
Type: STRING
Length (Max/Min): NA

Freeform Notes.  Can be left blank.

Example Values: notes to append

disallow_on_billing_status

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

If the conversion has been billed we should error indicating that it cannot be updated based off of the inputs for this field.
Affiliate = Do NOT bill if affiliate has been paid(partially/fully)
Advertiser = Do NOT bill if advertiser has been paid(partially/fully)
Both = Do NOT bill if either affiliate or advertiser has been paid(partially/fully)
Example Values
affiliate_paid or advertiser_paid or any_paid or ignore

 **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/4/track.asmx/UpdateConversion?api_key=YM6FNThM7EnEDC7AAGpp3K2oRjJdGFP&offer_id=55378734&conversion_id=869781&request_session_id=0&transaction_id=&payout=44&add_to_existing_payout=false&received=0&received_option=no_change&disposition_type=no_change&disposition_id=0&update_revshare_payout=false&effective_date_option=today&custom_date=01/01/2016&note_to_append=notes&disallow_on_billing_status=affiliate_paid


Sample XML Response:

 

Success Scenario

 

<?xml version="1.0" encoding="UTF-8"?>
<update_conversion_response>
   <success>true</success>
   <message>Conversion Updated</message>
</update_conversion_response>

 


 Already Billed Scenario

  

<?xml version="1.0" encoding="UTF-8"?>
<contact_addedit_response>
   <success>false</success>
   <message>Conversion has already been billed</message>
</contact_addedit_response>

 


 Missing Required Fields 

 

<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/3/"><success>false
</success>
<message>Conversion ID, Request Session ID, or Transaction ID Required
</message>
</update_conversion_response>

 

 

Example Error Messages:

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.