v1
latestOpenAPI 3.0.32026-07-2226694862.5 KBUpdate Offer
Path parameters
The unique offer ID.
Request body
ID of the advertiser submitting the offer.
Offer name.
URL of the final landing page associated with the offer, including additional macros if applicable.
Currency used to compute payouts, costs, and revenues of the offer.
Associated offer group.
URL of the image thumbnail associated with the offer, visible to network employees and affiliates.
Category ID.
Notes on the offer for network employees. Not displayed to affiliates and advertisers.
Server-side URL that will be asynchronously fired by Everflow following a click.
Landing page preview URL.
Description of the offer for the affiliates. HTML code is accepted.
Whether the description of the offer should be interpreted as plain text (true) or HTML (false).
Offer status.
Visibility setting for affiliates. Can be public, require_approval, or private.
ID for the advertiser campaign or an Insertion Order.
Date until when the offer can be run. Events occurring past the end of the day at the timezone of the network will be rejected. Format: YYYY-MM-DD.
Bundle ID for iOS / Android apps.
Labels used for organizing offers by private internal keywords.
ID of the timezone used for the caps if it differs from the network's default.
ID of the tracking domain hit by clicks belonging to the offer.
Method used by the advertiser to fire tracking data to Everflow. Deprecated values (http_image_pixel, https_image_pixel, cookie_based, http_iframe_pixel, https_iframe_pixel) are normalized to html_pixel_cookie_based.
Setting used to obscure referrer URLs from advertisers. Non-standard modes (single_meta_refresh, double_meta_refresh) are not recommended as they cause click drop-off.
Method used for determining whether a click is unique.
Duration (in hours) of the active session used to match a click to a conversion. Defaults to 24.
Whether soft caps are enabled for this offer.
Whether tracking links use https:// instead of http://. Validate with your account manager that SSL is enabled before using.
Whether affiliates can send their traffic to target URLs by adding &url=[target URL] to their tracking links, instead of the offer's destination URL.
Whether a check is made to ensure conversion postbacks originate from the advertiser.
Whether Direct Linking is enabled for this offer.
Whether caps are enabled. When false, voids all types of caps and custom caps.
Maximum number of unique conversions per day.
Maximum conversions per week (Monday midnight to Sunday 23:59:59).
Maximum conversions per month.
Maximum total conversions for this offer.
Whether duplicate clicks are filtered and acted upon, according to duplicate_filter_targeting_action.
Action to take when a duplicate click is detected. Ignored if is_duplicate_filter_enabled is false.
Whether clicks from users who have already converted on this offer are acted upon per already_converted_action.
Action to take for clicks from already-converted users. Ignored if is_block_already_converted is false.
Whether conversions must be manually approved before being finalized.
Whether duplicate conversions are allowed.
Whether a predefined percentage of conversions get automatically throttled (scrubbed). Only relevant if is_must_approve_conversion is true. This mechanism prevents an excessive number of conversions from being approved.
Status to apply to conversions affected by throttling. Required only if is_use_scrub_rate is true. Can be either rejected or pending.
Percentage of conversions to automatically throttle. Only relevant if is_use_scrub_rate is true.
Whether conversions can be generated from impressions (as opposed to clicks only).
URL of the final landing page when redirected from an impression, including additional macros if applicable. Only relevant if is_view_through_enabled is true.
Whether affiliate's conversions and payouts get automatically blocked based on a minimum and maximum time from the click to the associated conversion.
Maximum hours between click and valid conversion. Required if is_session_tracking_enabled is true.
Minimum seconds between click and valid conversion. Required if is_session_tracking_enabled is true.
Whether invalid clicks will be redirected to another offer.
Redirect mechanism that determines how fail traffic is distributed between listed offers. Can be priority, weight, priority_global, or weight_global. Only relevant when is_fail_traffic_enabled is true.
Whether an email suppression list is used for this offer.
ID of the suppression list associated with the offer. Only relevant if is_using_suppression_list is true.
Whether affiliate's conversions and payouts get automatically blocked based on a minimum and maximum time from the impression to the associated conversion. Only relevant if is_view_through_enabled is true.
Maximum interval of time (in minutes) between the impression event and a valid conversion or event. Required only if is_view_through_session_tracking_enabled is true.
Minimum seconds between impression and valid conversion. Only relevant if is_view_through_session_tracking_enabled is true.
Whether email attribution is enabled for this offer.
Method used for email attribution.
Whether the email attribution window is enabled.
Duration (in minutes) of the email attribution window.
Type of email attribution window.
Whether the offer uses specific Terms and Conditions. When false, defaults to the network's general Terms and Conditions.
Text listing the specific Terms and Conditions of the offer. Required only if is_using_explicit_terms_and_conditions is true.
Whether affiliates are required to accept the offer's specific Terms and Conditions.
Pre-approved source names for this offer.
Targeting ruleset for this offer. Contains nested arrays for geographic, device, browser, and connection-type targeting. Each targeting entry includes an ID, targeting_type (include or exclude), and match_type. Sub-objects include: platforms, device_types, os_versions, brands, browsers, languages, countries, regions, cities, dmas, mobile_carriers, isps, connection_types, ips, postal_codes. Also supports day parting via is_use_day_parting, day_parting_apply_to, day_parting_timezone_id, and days_parting array.
Response
Unique offer ID.
Advertiser that owns this offer.
Offer group ID.
Offer name.
Destination URL for the offer.
Server-side postback URL.
HTML description of the offer.
Internal notes (not visible to affiliates).
Offer expiration date (YYYY-MM-DD).
Setting used to obscure referrer URLs from advertisers. Non-standard modes (single_meta_refresh, double_meta_refresh) are not recommended as they cause click drop-off.
Method used for determining whether a click is unique.
Session duration in hours.
Maximum minutes between impression and valid conversion.
Minimum seconds between impression and valid conversion.
Encoded offer ID for use in tracking links.
Whether soft caps are enabled for this offer.
Unix timestamp of creation.
Unix timestamp of last update.
Example response
{
"payout_revenue": [
{
"remote_offer_resource": {
"time_created": 1734455015,
"time_saved": 1734455015
}
}
],
"time_created": 1734455015,
"time_saved": 1734455015,
"relationship": {
"advertiser": {
"time_created": 1734455015,
"time_saved": 1734455015
},
"category": {
"time_created": 1734455015,
"time_saved": 1734455015
},
"payout_revenue": {
"entries": [
{
"time_created": 1734455015,
"remote_offer_resource": {
"time_created": 1734455015,
"time_saved": 1734455015
}
}
]
},
"ruleset": {
"time_created": 1734455015,
"time_saved": 1734455015
},
"meta": {
"time_created": 1734455015,
"time_app_data_saved": 1734455015,
"time_saved": 1734455015
}
}
}