Offer Model

The essential collection of information for an offer. Models related to offers—extended information and related partners—refer to the ID field on this model.

Related support documentation:

NameTypeDescription
advertiser_idNullable IntegerID of Advertiser object associated to offer (if any)
allow_multiple_conversionsBoolean"Multiple Conversions" setting in Offer Tracking Settings.
approve_conversionsNullable BooleanApprove Conversions setting in Offer Tracking Settings. A null value is treated as false.
click_macro_urlNullable String"Click Macro URL" setting in Offer Tracking Settings. Applicable if disable_click_macro is set to false.
conversion_capInteger"Daily Conversions" cap setting in Offer Settings. A value of 0 means there is no general daily conversion cap for offer.
See: Conversion Caps
conversion_ratio_thresholdNullable Integer
This parameter has been deprecated.
[Deprecated]
converted_offer_idNullable IntegerID of Offer object for "Secondary Offer" setting in Offer Tracking Settings. Applicable only if converted_offer_type is set to "network".
converted_offer_typeStringCore "Secondary Offer" setting in Offer Tracking Settings. Applicable if "Redirect Offers" network-wide offer setting is enabled and "SEO Friendly Links" network-wide offer setting is disabled.Show Supported Values
converted_offer_urlNullable StringCustom URL value for "Secondary Offer" setting in Offer Tracking Settings. Applicable only if converted_offer_type is set to "url".
create_date_utcDatetimeDate the offer was created
This parameter is non-writable
currencyNullable String"Offer Currency" value in Offer Payout Settings, corresponding to three-character code as listed in Using Multiple Currencies. If set to null, offer uses "Currency" network-wide application setting. Returns error if attempting to set field to any other code.
Available only if "Multiple Currencies" network-wide application setting is enabled.
customer_list_idNullable IntegerID of CustomerList object associated with offer (if any)
See also: Customer Lists
default_goal_nameNullable StringName of default goal. Applicable only if has_goals_enabled is set to true.
default_payoutDecimalFlat payout amount for offer. Applicable only if payout_type is or includes a flat-amount type: "cpa_flat", "cpa_both", "cpc", or "cpm".
descriptionNullable StringOffer's description text/HTML
disable_click_macroBoolean"Click Macro" setting in Offer Tracking Settings. Is true if setting is set to "Disabled", false if set to "Enabled".
Applicable if "Global Click Macro" network-wide tracking setting is enabled.
display_advertiserBoolean"Display Advertiser" setting in Offer Settings Applicable if "Display Advertiser" network-wide offer setting is enabled.
dne_download_urlNullable StringContents of Download URL entry in suppression list associated to offer, as referred to in dne_list_id (if any).
Cannot write to this field. Use DneList controller to manipulate related DneList object.
This parameter is non-writable
dne_list_idNullable IntegerID of DneList object associated to offer (if any). Applicable only if show_mail_list is set to true.
See also: Suppression Lists
dne_third_party_listNullable BooleanFlag indicating if the offer uses a third-party DNE list.
See also: DneList controller, DneList model
This parameter is non-writable
dne_unsubscribe_urlNullable String"Contents of Unsubscrube URL" entry in suppression list associated to offer, as referred to in dne_list_id (if any).
Cannot write to this field. Use DneList controller to manipulate related DneList object.
This parameter is non-writable
email_instructionsBoolean"Email Instructions" setting in Offer Settings. Must be set to true for related fields to apply.
See also: Suppression Lists
email_instructions_fromNullable String"Contents of Approved From Lines" entry in offer's Suppression Lists settings. Use line breaks to separate multiple entries. Applicable if the "email_instructions" field is set to true.
email_instructions_subjectNullable String"Contents of Approved Subject Lines" entry in offer's Suppression Lists settings. Use line breaks to separate multiple entries. Applicable if the "email_instructions" field is set to true.
enable_offer_whitelistBoolean"Offer Whitelist" setting in Offer Tracking Settings
See also: Offer Whitelist
enforce_encrypt_tracking_pixelsBoolean"Encrypted Conversion Tracking" setting in Offer Tracking Settings. Applicable if "Encrypt Conversion URLs" network-wide tracking setting is enabled.
enforce_geo_targetingBoolean"Enforce Geo-Targeting" setting in Offer Targeting. Must be set to true for related fields to apply.
See: Geo-Targeting
expiration_dateDatetimeOffer's expiration date
has_goals_enabledBoolean"Multiple Conversion Goals" setting in Offer Payout. Must be set to true for related fields to apply.
See: Offer Goals
hostname_idNullable IntegerID of Hostname object associated to offer (if any), for use with custom tracking domains.
idIntegerThis object's ID, automatically generated upon creation.
This parameter is non-writable
is_expiredBooleanFlag indicating if offer has expired—if the current date is past the value in expiration_date
This parameter is non-writable
is_privateBoolean"Private" setting in Offer Settings
See also: Affiliate Access to Offers
is_seo_friendly_301Boolean"SEO-Friendly Links" setting in Offer Settings Applicable if "SEO-Friendly Links" network-wide offer setting is enabled.
See also: Tiny URLs & SEO-Friendly Links
is_subscriptionBoolean"Subscription" setting in Offer Tracking Settings
See also: Subscriptions
lifetime_conversion_capInteger"Lifetime Conversions" cap setting in Offer Settings. A value of 0 means there is no general lifetime conversion cap for offer.
See: Conversion Caps
lifetime_payout_capDecimal"Lifetime Payout" cap setting in Offer Settings. A value of 0 means there is no general lifetime payout cap for offer.
See: Conversion Caps
lifetime_revenue_capDecimal"Lifetime Reveune" cap setting in Offer Settings. A value of 0 means there is no general lifetime payout cap for offer.
See: Conversion Caps
max_payoutDecimalFlat revenue amount for offer. Applicable only if revenue_type is or includes a flat-amount type: "cpa_flat", "cpa_both", "cpc", or "cpm".
Note: Parameter name is a holdover. This does refer to offer's revenue values.
max_percent_payoutNullable DecimalPercentage of sale revenue for offer. Applicable only if revenue_type is or includes a percentage type: "cpa_percentage" or "cpa_both".
Note: Parameter name is a holdover. This does refer to offer's revenue values.
modifiedDatetimeTimestamp of most recent change to object
This parameter is non-writable
monthly_conversion_capInteger"Monthly Conversions" cap setting in Offer Settings. A value of 0 means there is no general monthly conversion cap for offer.
See: Conversion Caps
monthly_payout_capDecimal"Monthly Payout" cap setting in Offer Settings. A value of 0 means there is no general monthly payout cap for offer.
See: Conversion Caps
monthly_revenue_capDecimal"Monthly Revenue" cap setting in Offer Settings. A value of 0 means there is no general monthly revenue cap for offer.
See: Conversion Caps
nameStringOffer's display name
noteString"Notes" field in Offer Settings.
This parameter is exposed to advertiser and network users only, not to affiliate users.
offer_urlStringDefault offer URL/landing page offer redirects traffic to.
See Passing Values to Offer URLs for details on optional variables and macros.
payout_capDecimal"Daily Payout" cap setting in Offer Settings. A value of 0 means there is no general daily payout cap for offer.
See: Conversion Caps
payout_typeStringOffer's payout type, as described in Offer Payouts.
Values of "cpa_flat", "cpm", and "cpc" indicate a flat payout amount, which is specified in the default_payout field.
Value of "cpa_percentage" indicates payout is a percentage of sale, which is specified in the percent_payout field.
Value of "cpa_both" indicates both a flat payout amount and a percentage of sale payout.Show Supported Values
percent_payoutNullable DecimalPercentage of sale payout for offer. Applicable only if payout_type is or includes a percentage type: "cpa_percentage" or "cpa_both".
preview_urlStringURL used to preview page offer redirects to.
proactive_click_fraud_preventionStringOffer-level "Proactive Click Fraud Prevention" preference to screen clicks using the Fraudlogix fraud database. When set to "reject", clicks matching known sources of fraud are automatically rejected. This setting impacts clicks only if "Proactive Click Fraud Prevention" network-wide tracking setting is enabled.Show Supported Values
protocolStringConversion tracking protocol to use for offer.
See: Conversion Tracking EssentialsShow Supported Values
ratingNullable IntegerOffer's rating as displayed to affiliate and network users, ranked from 1 to 5. This field is active if the network has the Offer Ratings setting enabled.
See: Network-Wide Offer Settings
This parameter is non-writable
redirect_offer_idNullable IntegerID of Offer object for "Redirect Offer" setting in Offer Tracking Settings.
ref_idNullable String"Reference ID" setting in Offer Details
require_approvalBoolean"Require Approval" setting in Offer Settings
require_terms_and_conditionsString"Terms and Conditions" setting in Offer Settings
If set to "enabled," terms_and_conditions parameter should contain data.
Important: Use "enabled" and "disabled" for all inputs, including for data objects and filter options. However, values the API returns are "0" for disabled and "1" for enabled.Show Supported Values
revenue_capDecimal"Daily Revenue" cap setting in Offer Settings. A value of 0 means there is no general daily revenue cap for offer.
See: Conversion Caps
revenue_typeStringOffer's revenue type, as described in Offer Payouts.
Values of "cpa_flat", "cpm", and "cpc" indicate a flat revenue amount, which is specified in the max_payout field.
Value of "cpa_percentage" indicates revenue is a percentage of sale, which is specified in the max_percent_payout field.
Value of "cpa_both" indicates both a flat revenue amount and a percentage of sale revenue.
Note: Values are same as in payout_type for unity, rather than using "rpa_flat" etc.Show Supported Values
session_hoursInteger"Click Session Lifespan" setting in Offer Tracking Settings, in hours. Value cannot exceed 17520 hours (2 years).
session_impression_hoursInteger"Impression Session Lifespan" setting in Offer Tracking Settings, in hours. Value cannot exceed 17520 hours (2 years). Applicable only if set_session_on_impression is set to true.
set_session_on_impressionBoolean"Start Session Tracking" setting in Offer Tracking Settings; true is selection is for impressions, false if for clicks. Applicable only if protocol is set to a pixel-based value, otherwise defaults to false.
See: Impression Tracking
show_custom_variablesBoolean"Custom Variables" setting in Offer Tracking Settings.
See: Custom Variables
show_mail_listBoolean"Suppression List" setting in Offer Settings.
See: Suppression Lists
statusStringOffer's status
See: Offer OverviewShow Supported Values
subscription_durationNullable Integer"Subscription Duration" setting in Offer Tracking Settings, in seconds. A value of 0 means the duration is indefinite.
Applicable only if is_subscription is set to true.
subscription_frequencyNullable String"Subscription Frequency" setting in Offer Tracking Settings.
Applicable only if is_subscription is set to true.Show Supported Values
target_browsersInteger
This parameter has been deprecated.
[Deprecated]
terms_and_conditionsNullable StringOffer's terms and conditions text/HTML as shown in Offer Settings. Should contain non-empty value if require_terms_and_conditions is true.
tiered_payoutBooleanRelates to "Payout Method" setting in Offer Payout Settings. Is true if setting is set to "Tiered", false otherwise. Cannot be set to true if use_payout_groups is also true.
See: Payout & Revenue Tiers
tiered_revenueBooleanRelates to "Revenue Method" setting in Offer Payout Settings. Is true if setting is set to "Tiered", false otherwise. Cannot be set to true if use_revenue_groups is also true.
See: Payout & Revenue Tiers
use_payout_groupsBooleanRelates to "Payout Method" setting in Offer Payout Settings. Is true if setting is set to "Groups", false otherwise. Cannot be set to true if tiered_payout is also true.
See: Payout & Revenue Groups
use_revenue_groupsBooleanRelates to "Revenue Method" setting in Offer Payout Settings. Is true if setting is set to "Groups", false otherwise. Cannot be set to true if tiered_revenue is also true.
See: Payout & Revenue Groups
use_target_rulesBoolean"Advanced Targeting" setting in Offer Targeting. Set to true if "Show the offer to targeted devices" is selected.
See: Advanced Targeting
Have a Question? Please contact support@tune.com for technical support.