Offer::updateByRefId | TUNE Dev Hub

Jump to: GET Response Notes | API Call Builder

Updates specified properties of an existing offer based on a supplied reference ID (Offer.ref_id).

Note: this method fails if the reference ID matches zero offers or matches more than one offer. The reference ID must be unique, including among offers with a deleted status.

= Required Parameter

Name

Type

Description

ref_id

String

ref_id of Offer object

data

Object

Offer model properties to changeShow Supported Parameters

The following parameters are supported by this object.

Name	Type	Description
advertiser_id	Nullable Integer	ID of Advertiser object associated to offer (if any)
allow_direct_links	Boolean	"Direct Links" setting in Offer Tracking Settings See also: Direct Links
allow_multiple_conversions	Boolean	"Multiple Conversions" setting in Offer Tracking Settings.
allow_website_links	Boolean	"Deep Links" setting in Offer Tracking Settings See also: Deep Links
approve_conversions	Nullable Boolean	Approve Conversions setting in Offer Tracking Settings. A null value is treated as false.
click_macro_url	Nullable String	"Click Macro URL" setting in Offer Tracking Settings. Applicable if disable_click_macro is set to false.
conversion_cap	Integer	"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_threshold	Nullable Integer	This parameter has been deprecated. [Deprecated]
converted_offer_id	Nullable Integer	ID of Offer object for "Secondary Offer" setting in Offer Tracking Settings. Applicable only if converted_offer_type is set to "network".
converted_offer_type	String	Core "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.
converted_offer_url	Nullable String	Custom URL value for "Secondary Offer" setting in Offer Tracking Settings. Applicable only if converted_offer_type is set to "url".
currency	Nullable 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_id	Nullable Integer	ID of CustomerList object associated with offer (if any) See also: Customer Lists
default_goal_name	Nullable String	Name of default goal. Applicable only if has_goals_enabled is set to true.
default_payout	Decimal	Flat payout amount for offer. Applicable only if payout_type is or includes a flat-amount type: "cpa_flat", "cpa_both", "cpc", or "cpm".
description	Nullable String	Offer's description text/HTML
disable_click_macro	Boolean	"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_advertiser	Boolean	"Display Advertiser" setting in Offer Settings Applicable if "Display Advertiser" network-wide offer setting is enabled.
dne_list_id	Nullable Integer	ID of DneList object associated to offer (if any). Applicable only if show_mail_list is set to true. See also: Suppression Lists
email_instructions	Boolean	"Email Instructions" setting in Offer Settings. Must be set to true for related fields to apply. See also: Suppression Lists
email_instructions_from	Nullable 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_subject	Nullable 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_whitelist	Boolean	"Offer Whitelist" setting in Offer Tracking Settings See also: Offer Whitelist
enforce_encrypt_tracking_pixels	Boolean	"Encrypted Conversion Tracking" setting in Offer Tracking Settings. Applicable if "Encrypt Conversion URLs" network-wide tracking setting is enabled.
enforce_geo_targeting	Boolean	"Enforce Geo-Targeting" setting in Offer Targeting. Must be set to true for related fields to apply. See: Geo-Targeting
enforce_secure_tracking_link	Boolean	Enforce SSL by generating all affiliate tracking links and impression pixels with https instead of http
expiration_date	Datetime	Offer's expiration date
featured	Nullable Datetime	Date offer was selected as a featured offer (available at the network Snapshot page). If this is set to null or "0000-00-00 00:00:00", offer is not selected as a featured offer.
has_goals_enabled	Boolean	"Multiple Conversion Goals" setting in Offer Payout. Must be set to true for related fields to apply. See: Offer Goals
hostname_id	Nullable Integer	ID of Hostname object associated to offer (if any), for use with custom tracking domains.
is_private	Boolean	"Private" setting in Offer Settings See also: Affiliate Access to Offers
is_seo_friendly_301	Boolean	"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_subscription	Boolean	"Subscription" setting in Offer Tracking Settings See also: Subscriptions
lifetime_conversion_cap	Integer	"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_cap	Decimal	"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_cap	Decimal	"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_payout	Decimal	Flat 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_payout	Nullable Decimal	Percentage 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.
monthly_conversion_cap	Integer	"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_cap	Decimal	"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_cap	Decimal	"Monthly Revenue" cap setting in Offer Settings. A value of 0 means there is no general monthly revenue cap for offer. See: Conversion Caps
name	String	Offer's display name
non_unique_click_attribution	String	Offer-level "Non-Unique Click Attribution" preference to determine how non-unique clicks are handled. When set to "reject", clicks not determined to be unique are forwarded to the preview URL and are not eligible for conversion. This setting impacts clicks only if the "Non-Unique Click Attribution" network-wide tracking setting is enabled.
note	String	"Notes" field in Offer Settings. This parameter is exposed to advertiser and network users only, not to affiliate users.
offer_url	String	Default offer URL/landing page offer redirects traffic to. See Passing Values to Offer URLs for details on optional variables and macros.
payout_cap	Decimal	"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_type	String	Offer'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.
percent_payout	Nullable Decimal	Percentage of sale payout for offer. Applicable only if payout_type is or includes a percentage type: "cpa_percentage" or "cpa_both".
preview_url	String	URL used to preview page offer redirects to.
proactive_click_fraud_prevention	String	Offer-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.
protocol	String	Conversion tracking protocol to use for offer. See: Conversion Tracking Essentials
redirect_offer_id	Nullable Integer	ID of Offer object for "Redirect Offer" setting in Offer Tracking Settings.
ref_id	Nullable String	"Reference ID" setting in Offer Details
require_approval	Boolean	"Require Approval" setting in Offer Settings
require_terms_and_conditions	String	"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.
revenue_cap	Decimal	"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_type	String	Offer'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.
session_hours	Integer	"Click Session Lifespan" setting in Offer Tracking Settings, in hours. Value cannot exceed 17520 hours (2 years).
session_impression_hours	Integer	"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_impression	Boolean	"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_variables	Boolean	"Custom Variables" setting in Offer Tracking Settings. See: Custom Variables
show_mail_list	Boolean	"Suppression List" setting in Offer Settings. See: Suppression Lists
status	String	Offer's status See: Offer Overview
subscription_duration	Nullable 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_frequency	Nullable String	"Subscription Frequency" setting in Offer Tracking Settings. Applicable only if is_subscription is set to true.
target_browsers	Integer	This parameter has been deprecated. [Deprecated]
terms_and_conditions	Nullable String	Offer's terms and conditions text/HTML as shown in Offer Settings. Should contain non-empty value if require_terms_and_conditions is true.
tiered_payout	Boolean	Relates 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_revenue	Boolean	Relates 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_groups	Boolean	Relates 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_groups	Boolean	Relates 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_rules	Boolean	"Advanced Targeting" setting in Offer Targeting. Set to true if "Show the offer to targeted devices" is selected. See: Advanced Targeting
website_links_copy_static_params	Boolean	"Copy Static Parameters to Deep Links" setting in Offer Tracking Settings. Applicable only if allow_website_links is true. See also: Deep Links

Show Supported Parameters

return_object

Boolean

Returns created object if true; default true

GET Response Notes

If return_object is true, array: Offer model properties
If return_object is false, boolean: true if update is successful

API Call Builder

Javascript is required to use the API Call Builder.