# 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**](https://offerslook.gitbooks.io/api-documentation/content/offers/categories.html)**, 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**
```
{
"offer": {
"advertiser_id": 147,
"description": "This is our company's website address: http://www.offerslook.com.Welcome to visit!",
"destination_url": "http://www.offerslook.com",
"end_date": 1499025154,
"name": "offerslook",
"offer_approval": 1,
"payout_type": "CPA+CPS",
"payout": "54",
"percent_payout": "10",
"preview_url": "http://www.offerslook.com",
"revenue_type": "RPA+RPS",
"revenue": "55",
"percent_revenue": "10",
"start_date": 1499015154,
"status": "active",
"redirect_offer_id": 3,
"currency": "USD",
"conversion_protocol": 1,
"is_ssl": 1,
"approve_conversions": 1,
"unique_click_ip_count": 1,
"tracking_domain": "qoqololo.iuniontrack.com",
"lead_traffic": 0,
"hide_referral": 1,
"advertiser_offer_id": "555",
"app_id": "346328468",
"impression_status": 1,
"impression_url": "http://www.offerslook.com"
},
"offer_platform": {
"target": [
{
"platform": "Mobile",
"system": "iOS",
"version": [
"5.1",
"6.0",
"6.1"
],
"is_above": "1"
},
{
"platform": "Mobile",
"system": "Android",
"version": [
],
"is_above": "0"
},
{
"platform": "PC",
"system": null,
"version": null,
"is_above": "1"
}
]
},
"offer_geo": {
"type": 1,
"target": [
{
"country": "CN",
"type": 1
},
{
"country": "AL",
"type": 1
},
{
"country": "AM",
"type": 2
},
{
"country": "CN",
"region": {
"type":1,
"region_ids": ["633",635,641]
},
"cities": [{
"type": 1,
"region_id": "633",
"city_ids": ["97648",97649,97651]
},
{
"type": 2,
"region_id": "635",
"city_ids": ["97739"]
}]
}
]
},
"offer_category": {
"name": "MusicandAudio, TEST"
},
"offer_cap": {
"cap_timezone": "Australia/Lord_Howe",
"adv_cap_type": 2,
"adv_cap_conversion": 100,
"aff_cap_type": 3,
"aff_cap_payout": "100"
}
}
```
## Example response
```
{
"code": 0,
"message": "Success",
"data": {
"offer": {
"id": 16011,
"name": "offerslook",
"advertiser_id": 147,
"start_date": 1499015154,
"end_date": 1499025154,
"status": "active",
"offer_approval": 1,
"pricing_type": "Parameter deprecation. Pricing_type has been replaced by revenue_type and payout_type. Please review the new parameter method accordingly.",
"revenue_type": "RPA+RPS",
"revenue": "55",
"percent_revenue": "10.00",
"payout_type": "CPA+CPS",
"payout": "54",
"percent_payout": "10.00",
"preview_url": "http://www.offerslook.com",
"destination_url": "http://www.offerslook.com",
"description": "This is our company's website address: http://www.offerslook.com.Welcome to visit!",
"push_allowed": null,
"incent_allowed": null,
"adult_allowed": null,
"redirect_offer_id": 3,
"global_redirect_enabled": null,
"currency": "USD",
"conversion_protocol": 1,
"is_ssl": 1,
"approve_conversions": 1,
"unique_click_ip_count": 1,
"tracking_domain": "qoqololo.iuniontrack.com",
"lead_traffic": 0,
"hide_referral": 1,
"advertiser_offer_id": "555",
"app_id": "346328468",
"impression_status": 1,
"impression_url": "http://www.offerslook.com"
},
"offer_geo": {
"type": 1,
"target": [
{
"country": "China",
"country_code": "CN",
"id": 541628,
"city": null,
"type": null,
"offer_id": null,
"regions": [
{
"type": 1,
"region_id": 633,
"region_name": "Anhui Sheng"
},
{
"type": 1,
"region_id": 635,
"region_name": "Beijing Shi"
},
{
"type": 1,
"region_id": 641,
"region_name": "Guangxi Zhuangzu Zizhiqu"
}
],
"cities": [
{
"type": 1,
"region_id": 633,
"city_id": 97648,
"city_name": "Anqing"
},
{
"type": 1,
"region_id": 633,
"city_id": 97649,
"city_name": "Baiyin"
},
{
"type": 1,
"region_id": 633,
"city_id": 97651,
"city_name": "Bozhou"
},
{
"type": 2,
"region_id": 635,
"city_id": 97739,
"city_name": "Beijing"
}
]
},
"offer_cap": {
"id": 16011,
"offer_id": 16011,
"cap_budget": null,
"cap_click": null,
"cap_type": null,
"cap_conversion": null,
"adv_cap_type": 2,
"adv_cap_click": 0,
"adv_cap_conversion": 100,
"adv_cap_revenue": "0",
"aff_cap_type": 3,
"aff_cap_click": 0,
"aff_cap_conversion": 0,
"aff_cap_payout": "100.000",
"cap_timezone": "Australia/Lord_Howe"
},
"offer_category": [
{
"id": 148,
"name": "MusicandAudio",
"create_time": 1483511558,
"offer_id": 16011
},
{
"id": 154,
"name": "TEST",
"create_time": 1495700068,
"offer_id": 16011
}
],
"offer_platform": {
"target": [
{
"id": 3199,
"offer_id": 16011,
"platform": "Mobile",
"system": "iOS",
"version": [
"5.1",
"6.0",
"6.1"
],
"is_above": 1
},
{
"id": 3200,
"offer_id": 16011,
"platform": "Mobile",
"system": "Android",
"version": [
],
"is_above": 0
},
{
"id": 3201,
"offer_id": 16011,
"platform": "PC",
"system": "",
"version": [
],
"is_above": 1
}
]
}
}
}
```