ADDEDIT CampaignEvents 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 Campaign Card in the CAKE UI.
Resource/WSDL Page:
https://<your_domain_here>/api/2/addedit.asmx?op=CampaignEvents
Parameters
| api_key Required Type: STRING Length (Max/Min): 50 | Must be a valid API Key (existing and NOT expired) Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh |
| campaign_id Required Type: INT Length (Max/Min): NA | This field cannot be skipped Use Export Campaign API for Offer Contract ID: https://support.getcake.com/solution/articles/5000677656-export-campaigns-api-version-7 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 |
| use_campaign_default_pixel Required Type: ENUM length (Max/Min): NA | Enable on directed Campaign Card to fire the pixel found in Original Campaign Card 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 ifsetting to unpublished payout= must equal to 0. Example Values: on or off or no_change |
| postback_url Required Type: STRING Length (Max/Min): NA | Leaving this field empty will skip Enter NULL to erase current value in UI and edit the field to be left as blank Example Values: http://getcake.com?o=12&uniqueid=#s2# |
| postback_delay_ms Required Type: INT Length (Max/Min): NA | Enter 0 to skip this field Enter NULL to erase current value in UI and edit the field to be left as blank Example Values: 6 |
| pixel_html Required Type: STRING Length (Max/Min): NA | Enter 0 to skip this field Enter NULL to erase current value in UI and edit the field to be left as blank Example Values: <iframe src="https://cakemarketing.com/p.ashx?o=138&e=2&t=TRANSACTION_ID" height="1" width="1" frameborder="0"></iframe> |
Example Request
XML
<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>