Note: This service has changed all bool data types to enumerations with the option of do_not_change. In the scenario where you wish to edit an existing offer, you can bypass the bool fields by passing "do_not_change".

 

WSDL Page:  http://<your_domain_here>/api/3/addedit.asmx?op=Offer

 

Parameter Summary:

api_key / STRING = Admin API Key {See get.asmx > GetAPIKey}

offer_id / INT = Offer ID [Existing ID = Edit Offer / "0" = Create Offer]

advertiser_id / INT = Advertiser ID{See export.asmx > Advertisers}

vertical_id / INT (short) = Vertical ID {See get.asmx > Verticals}

offer_name / STRING = Offer Name

third_party_name / STRING = Offer 3rd Party Name

hidden / ENUMERATION = Hidden field on the Offer Card > Home tab. Used to remove access to the offer in the affiliate portal ["on","off","no_change"]

offer_status_id / INT (unsignedByte) = Offer Status ID ["1" = Public, "2" = Private, "3" = Apply To Run, "4" = Inactive]

offer_type_id / INT (unsignedByte) = Offer Type ID ["1" = Hosted, "2" = Host-n-Post, "3" = 3rd Party]

currency_id / INT (unsignedByte) = Payout Currency ID {See get.asmx > Currencies}

ssl / ENUMERATION = Redirect to a secure link? ["on","off","no_change"]

click_cookie_days / INT (short) = Click Cookie Days

impression_cookie_days / INT (short) = Impression Cookie Days

redirect_offer_contract_id / INT (unsignedByte) = Redirect Offer to redirect traffic to

redirect_404 / ENUMERATION = Send redirected traffic to a 404 page as opposed to the redirect offer? ["on","off","no_change"]

enable_view_thru_conversions / ENUMERATION = Enable View Thru Conversions? ["on","off","no_change"]

click_trumps_impression / ENUMERATION = Clicks Trump Impressions? ["on","off","no_change"]

disable_click_deduplication / ENUMERATION  = Disable Click Deduplication? ["on","off","no_change"]

last_touch / ENUMERATION = Last Touch? ["on","off","no_change"]

enable_transaction_id_deduplication / ENUMERATION = Enable Transaction ID Deduplication? ["on","off","no_change"]

postbacks_only / ENUMERATION = Restrict this offer to only track with postback URLs for third party conversion pixels? ["on","off","no_change"]

pixel_html/ STRING = Offer global conversion pixel

postback_url / STRING = Offer global postback url

postback_url_ms_delay / INT (short)= Offer global postback url ms delay. The amount of time in ms that the postback URL will wait be posted

fire_global_pixel / ENUMERATION = Fire global pixel? ["on","off","no_change"]

fire_global_pixel_on_non_paid_conversions / ENUMERATION = Fire global pixel on non paid conversions? ["on","off","no_change"]

static_suppression / INT (short) = Static suppression

conversion_cap_behavior / INT (unsignedByte) = How are conversions handled, when received after the offer hits cap ["1" = "Advertiser Payment, Affiliate Payment", "2" = "Advertiser Payment, No Affiliate Payment", "3" = "No Advertiser Payment, Affiliate Payment", "4" = "No Advertiser Payment, No Affiliate Payment", "5" = "Ignore Conversion"]

conversion_behavior_on_redirect INT (unsignedByte) = How are conversions handled, when they would result in a redirect ["1" = "Advertiser Payment, Affiliate Payment", "2" = "Advertiser Payment, No Affiliate Payment", "3" = "No Advertiser Payment, Affiliate Payment", "4" = "No Advertiser Payment, No Affiliate Payment", "5" = "Ignore Conversion"]

expiration_date / DATETIME = Date when the offer will expire. Required even if no expiration is needed. To ignore this field use the "expiration_date_modification_type=do_not_change" [MM/DD/YYYY HH:MM:SS]

expiration_date_modification_type / ENUMERATION = How should the expiration_date be used? ["do_not_change","change","remove"]

offer_contract_name / STRING = Offer contract name

offer_contract_hidden / ENUMERATION = Offer Contract Hidden? ["on","off","no_change"]

price_format_id / INT (unsignedByte) = Price Format ID {See get.asmx > GetPriceFormats}

payout / DECIMAL = Price Paid Per Conversion

received / DECIMAL = Price Received Per Conversion

received_percentage / ENUMERATION = Price Received Percentage? ["on","off","no_change"]

offer_link / STRING = Offer Landing Page URL

thankyou_link / STRING = Thank You Link URL

preview_link / STRING = Preview Link

thumbnail_file_import_url / STRING = Link to the image you want to use as the thumbnail for the offer.

offer_description / STRING = Offer Description

restrictions / STRING = Offer Restrictions

advertiser_extended_terms / STRING = Advertiser Extended Terms

testing_instructions / STRING = Testing Instructions

tags / STRING = Tags

allow_affiliates_to_create_creatives / ENUMERATION =Allow affiliates to create creatives? ["on","off","no_change"]

unsubscribe_link / STRING = Unsubscribe link location

from_lines / STRING = From lines

subject_lines / STRING = Subject lines

 

Parameter Types:

api_key - ASSIGNABLE  

offer_id - ID

advertiser_id - ID

vertical_id - ID

offer_name - ASSIGNABLE

third_party_name - ASSIGNABLE

hidden - ASSIGNABLE

offer_status_id - ID

offer_type_id - ID

currency_id - ID

ssl - ASSIGNABLE 

click_cookie_days - ASSIGNABLE   

impression_cookie_days - ASSIGNABLE   

redirect_offer_contract_id - ID   

redirect_404 - ASSIGNABLE   

enable_view_thru_conversions - ASSIGNABLE   

click_trumps_impression - ASSIGNABLE   

disable_click_deduplication - ASSIGNABLE   

last_touch - ASSIGNABLE   

enable_transaction_id_deduplication - ASSIGNABLE   

postbacks_only - ASSIGNABLE   

pixel_html - ASSIGNABLE   

postback_url - ASSIGNABLE   

postback_url_ms_delay - ASSIGNABLE   

fire_global_pixel - ASSIGNABLE   

fire_pixel_on_non_paid_conversions - ASSIGNABLE   

static_suppression - ASSIGNABLE   

conversion_cap_behavior - ASSIGNABLE   

conversion_behavior_on_redirect - ASSIGNABLE 

expiration_date - ASSIGNABLE   

expiration_date_modification_type - ASSIGNABLE

offer_contract_name - ASSIGNABLE   

offer_contract_hidden - ASSIGNABLE   

price_format_id - ID 

payout - ASSIGNABLE   

received - ASSIGNABLE   

received_percentage - ASSIGNABLE   

offer_link - ASSIGNABLE   

thankyou_link - ASSIGNABLE   

preview_link - ASSIGNABLE   

thumbnail_file_import_url - ASSIGNABLE   

offer_description - ASSIGNABLE   

restrictions - ASSIGNABLE   

advertiser_extended_terms - ASSIGNABLE   

testing_instructions - ASSIGNABLE   

tags - ASSIGNABLE   

allow_affiliates_to_create_creatives - ASSIGNABLE   

unsubscribe_link - ASSIGNABLE   

from_lines - ASSIGNABLE 

subject_lines - ASSIGNABLE

 

Sample GET Call:

http://demo.cakemarketing.com/api/3/addedit.asmx/Offer?api_key=dNJFmId9rI&offer_id=0&advertiser_id=1&vertical_id=41&offer_name=Awesome+Offer&third_party_name=Internal_123&hidden=off&offer_status_id=1&offer_type_id=1¤cy_id=1&ssl=off&click_cookie_days=30&impression_cookie_days=30&redirect_offer_contract_id=1131&redirect_404=off&enable_view_thru_conversions=off&click_trumps_impression=off&disable_click_deduplication=on&last_touch=off&enable_transaction_id_deduplication=off&postbacks_only=off&pixel_html=%3Cimg+src%22http%3A%2F%2Fexample.com%22%3E&postback_url=http%3A%2F%2Fexample.com%3Freqid%3D%23s2%23&postback_url_ms_delay=-1&fire_global_pixel=off&fire_pixel_on_non_paid_conversions=off&static_suppression=25&conversion_cap_behavior=0&conversion_behavior_on_redirect=0&expiration_date=1%2F1%2F2001&expiration_date_modification_type=do_not_change&offer_contract_name=&offer_contract_hidden=off&price_format_id=1&payout=100&received=150&received_percentage=off&offer_link=http%3A%2F%2Fbradsite.com&thankyou_link=http%3A%2F%2Fthanks.com&preview_link=http%3A%2F%2Fthanks.com&thumbnail_file_import_url=http%3A%2F%2Fwww.clipartbest.com%2Fcliparts%2FnTE%2Fz8G%2FnTEz8GzTA.gif&offer_description=Description+about+the+offer+to+be+displayed+in+the+Affiliate+portal.+Free+from+text.&restrictions=Restrictions+about+the+offer+to+be+displayed+in+the+Affiliate+portal.&advertiser_extended_terms=No+Free+Give+away.+No+Craigslist.&testing_instructions=Submit+first+name+and+email+address.+Dupes+will+be+scrubbed.&tags=Offer+Import%2C+International%2C+Email%2C+Restrictions&allow_affiliates_to_create_creatives=no_change&unsubscribe_link=&from_lines=&subject_lines=

 

Sample XML Response:

<?xml version="1.0" encoding="utf-8"?>
<offer_addedit_response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://cakemarketing.com/api/3/">
  <success>true</success>
  <message>Offer 55378176 Created</message>
  <success_info>
    <offer_id>55378176</offer_id>
    <offer_contract_id>4056</offer_contract_id>
    <campaign_id>27340</campaign_id>
    <creative_id>1135747</creative_id>
  </success_info>
</offer_addedit_response>