TRACK UpdateSaleRevenue API

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

 

Summary:

Enables the update of revenue for a specific lead sale based upon a Lead ID passed in.

 

Resource/WSDL Page:

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

 

Parameters

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

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

Example Values: Fo35NRAqvFLXoZxqB4aVMhh

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

Buyer Contract associated with the lead to be updated.

Example Values: 123456 

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

Lead ID related to the lead.

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

note_to_append
Required
Type: STRING
Length (Max/Min): NO

Freeform Notes

Example Value: These are the notes associated with the update I just made.

 **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/UpdateSaleRevenue?
api_key=dNJFmId9rI&buyer_contract_id=659&lead_id=F0E41C8D
&add_to_existing=TRUE&amount=15.00
&note_to_append=Here+is+where+I'm+putting+my+notes

 

Sample XML Response:

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

 

Example Error Messages: 

Error Message

Likely Cause

Invalid API Key

API Key does not exist or is expired.

Sale Not Found

Sale count not be found using the supplied buyer_contract_id and the lead_id.