ADDEDIT SiteOfferEvents API Version 2
Updated on 2019-12-26
Current Version: Version 2
Deprecated Version: 1
Requests Allowed: GET&SOAP
Summary:
This API will allow managing settings found in the Events Tab of the Offer Card in the CAKE UI.
Resource/WSDL Page:
https://<your_domain_here>/api/2/addedit.asmx?op=SiteOfferEvents
Parameters
| api_key Required Type: STRING Length (Max/Min): 50 | Must be a valid API Key (existing and NOT expired) Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh |
| site_offer_contract_id Required Type: INT Length (Max/Min): NA | This field cannot be skipped Use Export Offers API for Offer Contract ID: https://support.getcake.com/solution/articles/5000655203-export-offers-api-version-6 Example Values: 1234 |
| event_id Required Type: INT Length (Max/Min): NA | This field cannot be skipped. Use Export Advertisers API for Event ID: https://support.getcake.com/solution/articles/13000001689-export-advertisers-api-version-6 Example Values: 3962 |
| active Required Type: ENUM Length (Max/Min): NA | Enable or disable this Event Status Example Values: on, off, no_change |
| payout_modification_type Required Type: ENUM length (Max/Min): NA | Sets payout type Example Values: do_not_change, change, remove |
| payout Required Type: DECIMAL Length (Max/Min): NA | This field can be ignored if payout_modification_type is set to 'no_change' Enter NULL if payout_modification_type is set to 'remove' Example Values: 10.5 |
| publish_event Required Type: ENUM Length (Max/Min): NA | Set event to published or unpublished or leave as is. On edit, if setting to unpublished payout= must equal to 0. Example Values: on or off or no_change |
| received_modification_type Required Type: ENUM Length (Max/Min): NA | Sets received type Example Values: do_not_change, change, remove |
| received Required Type: DECIMAL Length (Max/Min): NA | This field can be ignored if received_modification_type is set to 'no_change' Enter NULL if received_modification_type is set to 'remove' Example Values: 20.5 |
| minimum_seconds_to_conversion Required Type: INT Length (Max/Min): NA | Enter 0 set value to '0' to skip Enter -1 to skip field Enter -2 to remove value from the field Example Values: 6 |
Example Request
<offer_event_addedit_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>Event 55378222 Updated</message>
</offer_event_addedit_response>XML