Create a new offer
HTTP method
Endpoint
POST
/v1/offers
Notice:push_allowed, incent_allowed and adult_allowed in offer are discontinued and wont’ be processed. They are moved to Offer subresource, category, for setting. Please review corresponding method (offer_categroy means the tag information).
Request body parameters
Field
Type
Description
Nullable
offer
name
string
The name of the this Offer
No
advertiser_id
integer
The ID of the Advertiser this Offer is for, if applicable
No
start_date
integer
The activation date of the Offer.
end_date
integer
The expiration date of the Offer.
status
string
The status of the Offer. Allowed values: active·paused·pending·deleted, pending (default)
offer_approval
integer
Whether this Offer requires manual approval before an Affiliate can run it. Possible Values: 1 Require Approval 2 Public 3 Private.
No
pricing_type
string
Parameter deprecation Pricing_type has been replaced by revenue_type and payout_type. Please review the new parameter method accordingly.
revenue_type
string
Specifies the method of calculating revenues for this Offer. Allowed values: RPC · RPI · RPA · RPL · RPS · RPM · RPA+RPS Values of "RPC", “RPI”, "RPM", "RPL" and "RPA" indicate a flat revenue amount, which is specified in the revenue field. Value of "RPS " indicates revenue is a percentage of sale, which is specified in the percent_revenue field. Value of "RPA+RPS " indicates both a flat revenue amount and a percentage of sale revenue.
No
revenue
string
The flat rate/amount revenue. This is applicable depending on the "revenue_type " of the Offer. Applicable only if revenue_type is “RPC”, “RPA”, “RPM”, "RPI", "RPL" or “RPA+RPS”.
percent_revenue
string
Percentage of sale revenue for offer. Applicable only if revenue_type is “RPS” or “RPA+RPS”.
payout_type
string
Offer's payout type. Allowed values: CPC · CPI · CPA · CPL · CPM ·CPS · CPA+CPS Values of "CPC" ,"CPI" ,"CPM", "CPL" and "CPA" indicate a flat payout amount, which is specified in the payout field. Value of "CPS " indicates payout is a percentage of sale, which is specified in the percent_payout field. Value of "CPA+CPS " indicates both a flat payout amount and a percentage of sale payout.
No
payout
string
The flat rate/amount paid for this Offer. Applicable for Offers whose "payout_type" includes a flat rate component. Applicable only if payout_type is “CPC”, “CPA” ,"CPI" ,"CPM", "CPL" or “CPA+CPS”.
percent_payout
string
Percentage of sale payout for offer. Applicable only if payout_type is “CPS” or “CPA+CPS”.
preview_url
string
URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page.
No
destination_url
string
The default Offer URL where traffic will be redirected to. Several optional variables/macros can be included in an Offer URL.
No
description
string
A description for the Offer.
redirect_offer_id
integer
The ID of another Offer to redirect traffic to if the offer has exceeded its conversion cap or the Offer is paused.
currency
string
The currency of the Offer. USD(Default)
conversion_protocol
integer
The Conversion tracking method to use for the Offer. Allowed values: 1 Image Pixel; 2 Postback URL; 3 iFrame Pixel Postback URL (Default)
is_ssl
integer
Enforce SSL by generating all affiliate tracking links and impression pixels with https instead of http. Allowed values: 0 Close; 1 Open Close ( Default )
approve_conversions
integer
Whether Conversions for this Offer must be manually approved. If enabled, Conversions will receive a "status" of "pending" when generated. Allowed values: 0 Close; 1 Open Close ( default ) Note：If Offer pricing type is CPC, the value will be Close and can’t be changed.
unique_click_ip_count
integer
Unique IP Tracking. When you set more than 0, the system will filter the part of clicks out of the allowed repetition of independent IPs.
tracking_domain
string
multipul custom domain
lead_traffic
integer
1=Enabled , 0=Disabled
client_forward
integer
1=Enabled , 0=Disabled Note：Before opening client_forward, you must first open lead_traffic, otherwise the input is invalid.
advertiser_offer_id
string
advertiser offer id
app_id
string
the App ID on app store or google play
hide_referral
integer
0=Default 1=Enabled , 2=Disabled
impression_status
string
1=Enabled , 0=Disabled
impression_url
string
The Impression Offer URL where Impression Pixel will be redirected to
click_signing_name
string
When you select Appsflyer, the corresponding ID is returned.Possible Values:0 Disabled;ID(Appsflyer) Enabled
carrier_mode
integer
carrier_mode indicates the Mobile Carrier type.1 indicates include. 2 indicates exclude. 1 by default.
offer_platform
platform
string
Devices to be targeted, eg: PC/Mobile/Tablet If not selected, by default it allows all platforms.
system
string
Operating System in platforms,by defaut it allows all OS without setting.
version
array
OS Version.By defaut it allows all versions in the selected OS.
is_above
integer
A new field, is_above, is added to offer platform to support upper compatibility in platform. When new platform versions are upgraded, the traffic won’t be rejected. Allowed values: 0 Close; 1 Open
offer_geo
country
string
Country to be targeted. Compatible with country name and country code. When the country is identified as the exclusion (type=2), the city is not optional.
type
integer
An identifier included or excluded. Type: 1 include ; 2 exclude
regions
Regions selection in targeted country
type
integer
An identifier included or excluded. Type: 1 include ; 2 exclude
region_ids
array
the unique id for the region
cities
City selection in targeted region
type
integer
An identifier included or excluded. Type: 1 include ; 2 exclude
region_id
integer
the unique id for the region
city_ids
array
the unique id for the city
offer_category
name
array
Types. A plurality of times, separated by a comma.
offer_cap
adv_cap_type
integer
Cap type: 0 none 1 total_count 2 daily_count 3 revenue
adv_cap_click
integer
Advertiser cap click limit.
adv_cap_conversion
integer
Advertiser cap conversion limit.
adv_cap_revenue
string
Advertiser cap revenue limit.
aff_cap_type
integer
Cap type: 0 none 1 total_count 2 daily_count 3 payout
aff_cap_click
integer
Affiliate cap click limit.
aff_cap_conversion
integer
Affiliate cap conversion limit.
aff_cap_payout
string
Affiliate cap payout limit.
cap_timezone
string
Timezone
Tracking Parameters
{click_id}
{offer_id}
{event_id}
{country_id}
{aff_id}
{adv_id}
{adv_sub1}
{adv_sub2}
{adv_sub3}
{aff_sub1}
{aff_sub2}
{aff_sub3}
{aff_sub4}
{aff_sub5}
{source_id}
{agent}
{click_time}
{payout}
{referer}
{accept_lan}
{ip}
{unique_click}
{currency}
{ios_idfa}
{android_id}
{google_aid}
{conversion_ip}
{amount}
Response body parameters
Field
Type
Description
offer
id
integer
A string that uniquely identifies this offer.
name
string
The name of the this Offer
advertiser_id
integer
The ID of the Advertiser this Offer is for, if applicable
start_date
integer
The activation date of the Offer.
end_date
integer
The expiration date of the Offer.
status
string
The current status of the offer.
offer_approval
integer
Whether this Offer requires manual approval before an Affiliate can run it.
pricing_type
string
Parameter deprecation Pricing_type has been replaced by revenue_type and payout_type. Please review the new parameter method accordingly.
revenue_type
string
Specifies the method of calculating revenues for this Offer. Allowed values: RPC · RPA · RPL · RPI · RPS · RPM · RPA+RPS Values of "RPC", "RPI", "RPM", "RPL" and "RPA" indicate a flat revenue amount, which is specified in the revenue field. Value of "RPS " indicates revenue is a percentage of sale, which is specified in the percent_revenue field. Value of "RPA+RPS " indicates both a flat revenue amount and a percentage of sale revenue.
revenue
string
The flat rate/amount revenue. This is applicable depending on the "revenue_type " of the Offer. Applicable only if revenue_type is “RPC”, "RPI", "RPM", “RPA”, "RPL" or “RPA+RPS”.
percent_revenue
string
Percentage of sale revenue for offer. Applicable only if revenue_type is “RPS” or “RPA+RPS”.
payout_type
string
Offer's payout type. Allowed values: CPC · CPA · CPL · CPI · CPM · CPS · CPA+CPS Values of "CPC","CPI", "CPM", "CPL" and "CPA" indicate a flat payout amount, which is specified in the payout field. Value of "CPS " indicates payout is a percentage of sale, which is specified in the percent_payout field. Value of "CPA+CPS " indicates both a flat payout amount and a percentage of sale payout.
payout
string
The flat rate/amount paid for this Offer. Applicable for Offers whose "payout_type" includes a flat rate component. Applicable only if payout_type is “CPC”, “CPA”, "CPM", "CPI", "CPL" or “CPA+CPS”.
percent_payout
string
Percentage of sale payout for offer. Applicable only if payout_type is “CPS” or “CPA+CPS”.
preview_url
string
URL that often skips any geo-targeting or other re-targeting implemented by the Offer URL. Allows Affiliates to view sample landing page.
destination_url
string
The default Offer URL where traffic will be redirected to. Several optional variables/macros can be included in an Offer URL.
description
string
A description for the Offer.
redirect_offer_id
integer
The ID of another Offer to redirect traffic to if the offer has exceeded its conversion cap or the Offer is paused.
global_redirect_enabled
integer
This parameter has been deprecated. [Deprecated]
currency
string
The currency of the Offer.
conversion_protocol
integer
The Conversion tracking method to use for the Offer. Possible Values: 1 Image Pixel; 2 Postback URL; 3 iFrame Pixel
is_ssl
integer
Enforce SSL by generating all affiliate tracking links and impression pixels with https instead of http. Allowed values: 0 Close; 1 Open
approve_conversions
integer
Whether Conversions for this Offer must be manually approved. If enabled, Conversions will receive a "status" of "pending" when generated. Allowed values: 0 Close; 1 Open
unique_click_ip_count
integer
Unique IP Tracking. When you set more than 0, the system will filter the part of clicks out of the allowed repetition of independent IPs.
tracking_domain
string
multipul custom domain
lead_traffic
integer
1=Enabled , 2=Disabled
advertiser_offer_id
string
advertiser offer id
app_id
string
the App ID on app store or google play
hide_referral
integer
1=Enabled , 2=Disabled
impression_status
string
1=Enabled , 0=Disabled
impression_url
string
The Impression Offer URL where Impression Pixel will be redirected to
carrier_mode
integer
carrier_mode indicates the Mobile Carrier type.1 indicates include. 2 indicates exclude. 1 by default.
offer_platform
id
integer
offer_id
integer
A string that uniquely identifies this offer.
platform
string
Devices to be targeted, it might be PC/Mobile/Tablet
system
string
Operating System in Device. By default it allows all OS in targeted platform.
version
array
Version of the system. By default it allows all versions in targeted system
is_above
integer
A new field, is_above, is added to offer platform to support upper compatibility in platform. When new platform versions are upgraded, the traffic won’t be rejected. Allowed values: 0 Close; 1 Open
offer_geo
id
integer
offer_id
integer
A string that uniquely identifies this offer.
country
string
Country to be targeted.
country_code
string
Country code.
type
integer
An identifier included or excluded. Type: 1 include ; 2 exclude
region
array
Regions in targeted country
type
integer
An identifier included or excluded. Type: 1 include ; 2 exclude
region_ids
integer
the unique id for the region
region_name
string
the name of the region
cities
City in targeted Region
type
integer
An identifier included or excluded. Type: 1 include ; 2 exclude
region_id
integer
the unique id for the region
city_id
integer
the unique id for the city
city_name
string
the name of the city
offer_category
id
integer
offer_id
integer
A string that uniquely identifies this offer.
name
array
Types
create_time
string
Create time for classification.
offer_cap
id
integer
offer_id
A string that uniquely identifies this offer.
adv_cap_type
integer
Cap type: 0 none 1 total_count 2 daily_count 3 revenue
adv_cap_click
integer
Advertiser cap click limit.
adv_cap_conversion
integer
Advertiser cap conversion limit.
adv_cap_revenue
string
Advertiser cap revenue limit.
aff_cap_type
integer
Cap type: 0 none 1 total_count 2 daily_count 3 payout
aff_cap_click
integer
Affiliate cap click limit.
aff_cap_conversion
integer
Affiliate cap conversion limit.
aff_cap_payout
string
Affiliate cap payout limit.
cap_timezone
string
Example request
Request POST https://{networkname}.api.offerslook.com/v1/offers
Example response
Last updated