TRACK Update Lead Price API
Updated on 2014-04-07
Current Version: Version 2
Deprecated Version: v1
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://yourdomainhere/api/2/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: A123E4 |
| add_to_existing Required Type: BOOL Length (Max/Min): N/A | Add Amount to Existing Price? ["TRUE" = Add, "FALSE" = Overwrite] Example Value: TRUE |
| amount Required Type: DECIMAL Length (Max/Min): N/A | Price 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 |
| effective_date_option Required Type: STRING Length (Max/Min): N/A | The effective date these changes should be applied to. ["today", "conversion_date", "custom"] Example Value: custom |
| custom_date Required Type: DATETIME Length (Max/Min): N/A | This date field is only used on effective_date_option = custom, otherwise this date is ignored.[MM/DD/YYYY HH:MM:SS] Example Value: 12/12/2013 14:31:59 |
**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
Sample XML Response:
<update_lead_price_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/1/">
<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 |