---
agentTools:
projectIndex: https://offer18.readme.io/llms.txt
---
# Offer Create API
[block:html]
{
"html": "
\n← Return to Main Knowledgebase
\n
\n
"
}
[/block]
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Offers API",
"version": "1.0"
},
"servers": [
{
"url": "https://api.offer18.com/api/m/offer_create"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "apiKey",
"in": "query",
"name": "mid"
},
"sec1": {
"type": "apiKey",
"in": "query",
"name": "api-key"
},
"sec2": {
"type": "apiKey",
"in": "query",
"name": "secret-key"
}
}
},
"security": [
{
"sec0": [],
"sec1": [],
"sec2": []
}
],
"paths": {
"/": {
"post": {
"summary": "Offer Create API",
"description": "",
"operationId": "offers-api",
"parameters": [
{
"name": "type",
"in": "query",
"description": "Allowed Values: create / update",
"schema": {
"type": "string",
"enum": [
"create",
"update"
]
}
},
{
"name": "oid",
"in": "query",
"description": "Required in Offer Update",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Accept",
"in": "header",
"schema": {
"type": "string",
"default": "text/html, application/xhtml+xml, application/xml;q=0.9, image/webp"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"required": [
"offer_name",
"advertiser_id",
"offer_url"
],
"properties": {
"offer_name": {
"type": "string",
"description": "Name of the Campaign"
},
"advertiser_id": {
"type": "integer",
"description": "Advertiser ID",
"format": "int32"
},
"offer_url": {
"type": "string",
"description": "Campaign's URL"
},
"external_offer_id": {
"type": "string",
"description": "External Campaign id (if any)"
},
"app_id": {
"type": "string",
"description": "App id (if any)"
},
"logo": {
"type": "string",
"description": "URL of the Campaign's logo"
},
"category": {
"type": "string",
"description": "Category of the Campaign"
},
"preview_url": {
"type": "string",
"description": "Preview URL of the Campaign"
},
"currency": {
"type": "string",
"description": "Currency of the Campaign",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"UYI",
"UYU",
"UYW",
"UZS",
"VED",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XSU",
"XTS",
"XUA",
"XXX",
"YER",
"ZAR",
"ZMW",
"ZWL"
]
},
"price_advertiser": {
"type": "string",
"description": "Price given by Advertiser for Campaign"
},
"price_affiliate": {
"type": "number",
"description": "Price given to Affiliate for Campaign",
"format": "float"
},
"model_advertiser": {
"type": "string",
"description": "Model from the Advertiser",
"enum": [
"CPC",
"CPV",
"CPL",
"CPD",
"CPA",
"CPI",
"CPS",
"CPR",
"CPM",
"CPCV",
"CPAS"
]
},
"model_affiliate": {
"type": "string",
"description": "Model for the Affiliate",
"enum": [
"CPC",
"CPV",
"CPL",
"CPD",
"CPA",
"CPI",
"CPS",
"CPR",
"CPM",
"CPCV",
"CPAS"
]
},
"hide_affiliate_payout": {
"type": "string",
"description": "Allowed values 1: To hide Affiliate Payout",
"enum": [
"1"
]
},
"start_datetime": {
"type": "string",
"description": "Start date / time (YYYY-MM-DD HH:MM:SS)"
},
"end_datetime": {
"type": "string",
"description": "End date / time (YYYY-MM-DD HH:MM:SS )",
"format": "date-time"
},
"visibility": {
"type": "string",
"description": "Allowed values: public, permission, private",
"enum": [
"public",
"permission",
"private"
]
},
"status": {
"type": "string",
"description": "Allowed values: approve, pending",
"enum": [
"approve",
"pending"
]
},
"deep_links": {
"type": "string",
"description": "Allowed values 1: To enable deeplinks in Offers",
"enum": [
"1"
]
},
"offer_terms": {
"type": "string",
"description": "Terms of the Campaign"
},
"offer_kpi": {
"type": "string",
"description": "KPI terms of the Campaign"
},
"private_note": {
"type": "string",
"description": "Private Notes in Campaign"
},
"imps_url": {
"type": "string",
"description": "Impression URL"
},
"landing_page_name_1": {
"type": "string",
"description": "Name of the first landing page"
},
"landing_page_url_1": {
"type": "string",
"description": "URL of the first landing page for Campaign"
},
"landing_page_name_2": {
"type": "string",
"description": "Name of the second landing page"
},
"landing_page_url_2": {
"type": "string",
"description": "URL of the second landing page for Campaign"
},
"creatives": {
"type": "string",
"description": "URL of the Creatives for the Campaign"
},
"capping_rule_id": {
"type": "string",
"description": "In case you wants to Update existing capping rule"
},
"capping": {
"properties": {
"0": {
"properties": {
"capping_rule_name": {
"type": "string",
"description": "Capping Rule Name"
},
"capping_rule_type": {
"type": "string",
"description": "Type of capping rule",
"enum": [
"advertiser_capping",
"affiliate_capping"
]
},
"capping_timezone": {
"type": "string",
"description": "Capping Timezone (-12:00) Eniwetok, Kwajalein, (-11:00) Midway Island, Samoa, (-10:00) Hawaii, (-9:00) Alaska, (-8:00) Pacific Time (US & Canada) , (-7:00) Mountain Time (US & Canada) , (-6:00) Central Time (US & Canada) , Mexico City, (-5:00) Eastern Time (US & Canada) , Bogota, Lima, (-4:00) Atlantic Time (Canada) , Caracas, La Paz, (-3:30) Newfoundland, (-3:00) Brazil, Buenos Aires, Georgetown , (-2:00) Mid-Atlantic, (-1:00) Azores, Cape Verde Islands , (+0:00) UTC, Western Europe Time, London, Lisbon, Casablanca , (+1:00) Brussels, Copenhagen, Madrid, Paris, (+2:00) Kaliningrad, South Africa, (+3:00) Baghdad, Riyadh, Moscow, St. Petersburg , (+3:30) Tehran , (+4:00) Abu Dhabi, Muscat, Baku, Tbilisi , (+4:30) Kabul, (+5:00) Ekaterinburg, Islamabad, Karachi, Tashkent , (+5:30) Bombay, Calcutta, Madras, New Delhi, (+5:45) Kathmandu, (+6:00) Almaty, Dhaka, Colombo , (+7:00) Bangkok, Hanoi, Jakarta , (+8:00) Beijing, Perth, Singapore, Hong Kong , (+9:00) Tokyo, Seoul, Osaka, Sapporo, Yakutsk, (+9:30) Adelaide, Darwin, (+10:00) Eastern Australia, Guam, Vladivostok , (+11:00) Magadan, Solomon Islands, New Caledonia , (+12:00) Auckland, Wellington, Fiji, Kamchatka",
"enum": [
"-12.00",
"-11.00",
"-10.00",
"-9.00",
"-8.00",
"-7.00",
"-6.00",
"-5.00",
"-4.00",
"-3.50",
"-3.00",
"-2.00",
"-1.00",
"0.00",
"1.00",
"2.00",
"3.00",
"3.50",
"4.00",
"4.50",
"5.00",
"5.50",
"5.75",
"6.00",
"7.00",
"8.00",
"9.00",
"9.50",
"10.00",
"11.00",
"12.00"
]
},
"capping_events": {
"type": "string",
"description": "Capping events"
},
"capping_type": {
"type": "string",
"description": "Type of capping",
"enum": [
"gross_conversions",
"approved_conversions",
"gross_revenue",
"approved_revenue",
"gross_payout",
"approved_payout",
"gross_clicks",
"approved_clicks"
]
},
"capping_period": {
"type": "string",
"enum": [
"daily",
"weekly",
"monthly",
"hourly"
]
},
"capping_value": {
"type": "integer",
"description": "Capping Value",
"format": "int32"
},
"overcap_action": {
"type": "string",
"description": "Overcap Action",
"enum": [
"stop",
"fallback",
"fallback_conversion_accept",
"conversion_accept",
"conversion_reject",
"conversion_pending"
]
},
"capping_notification_email": {
"type": "string",
"description": "Capping Notification Email"
},
"capping_affiliate_visibility": {
"type": "string",
"enum": [
"1"
]
},
"capping_affiliate_id": {
"type": "string",
"description": "Affiliate ID's (Comma seperated)"
}
},
"required": [],
"type": "object"
}
},
"required": [],
"type": "object"
},
"fallback": {
"type": "string",
"description": "Allowed values: 1: To enable Fallback",
"enum": [
"1"
]
},
"fallback_offer_id": {
"type": "integer",
"description": "Fallback's Offer id",
"format": "int32"
},
"fallback_url": {
"type": "string",
"description": "URL of the Fallback"
},
"fraud_conv_speed": {
"type": "integer",
"description": "Time in seconds",
"format": "int32"
},
"proxy_block": {
"type": "string",
"description": "Allowed values: 1: To block proxies",
"enum": [
"1"
]
},
"blank_ref_block": {
"type": "string",
"description": "Allowed values: 1: To block blank Reference",
"enum": [
"1"
]
},
"hide_referral": {
"type": "string",
"description": "Allowed values: 1: To hide referral",
"enum": [
"1"
]
},
"assign_affiliates": {
"type": "integer",
"description": "Assign Affiliates to this Campaign (Comma-separated values)",
"format": "int32"
},
"target_country": {
"type": "string",
"description": "AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BH, BS, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW"
},
"block_country": {
"type": "string",
"description": "AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BH, BS, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW"
},
"target_os": {
"type": "string",
"description": "android, ios, windows, blackberry_os, chrome_os, windows_mobile, windows_phone, webos, tizen"
},
"block_os": {
"type": "string",
"description": "android, ios, windows, blackberry_os, chrome_os, windows_mobile, windows_phone, webos, tizen"
},
"target_device": {
"type": "string",
"description": "desktop,smartphone,tablet,feature_phone,tv,phablet,smart_display,console"
},
"block_device": {
"type": "string",
"description": "desktop,smartphone,tablet,feature_phone,tv,phablet,smart_display,console"
},
"target_browser": {
"type": "string",
"description": "360 Phone Browser, 360 Browser, Avant Browser, ABrowse, ANT Fresco, ANTGalio, Aloha Browser, Amaya, Amigo, Android Browser, Arora, Amiga Voyager, Amiga Aweb, Atomic Web Browser, BlackBerry Browser, Baidu Browser, Baidu Spark, Beonex, Bunjalloo, B-Line, Brave, BriskBard, BrowseX, Camino, Coc Coc, Comodo Dragon, Coast, Charon, Chrome Frame, Chrome, Chrome Mobile iOS, Conkeror, Chrome Mobile, CoolNovo, CometBird, ChromePlus, Chromium, Cyberfox, Cheshire, dbrowser, Deepnet Explorer, Dolphin, Dorado, Dooble, Dillo, Epic, Elinks, Element Browser, GNOME Web, Espial TV Browser, Firebird, Fluid, Fennec, Firefox, Flock, Firefox Mobile, Fireweb, Fireweb Navigator, Galeon, Google Earth, HotJava, Iceape, IBrowse, iCab, iCab Mobile, Iridium, IceDragon, Isivioo, Iceweasel, Internet Explorer, IE Mobile, Iron, Jasmine, Jig Browser, Kindle Browser, K-meleon, Konqueror, Kapiko, Kylo, Kazehakase, Liebao, LG Browser, Links, LuaKit, Lunascape, Lynx, MicroB, NCSA Mosaic, Mercury, Mobile Safari, Midori, MIUI Browser, Mobile Silk, Maxthon, Nokia Browser, Nokia OSS Browser, Nokia Ovi Browser, NetFront, NetFront Life, NetPositive, Netscape, Obigo, Odyssey, Web Browser, Off By One, ONE Browser, Opera Mini, Opera Mobile, Opera, Opera Next, Oregano, Openwave Mobile Browser, OmniWeb, Otter Browser, Palm Blazer, Pale Moon, Palm Pre, Puffin, Palm WebPro, Palmscape, Phoenix, Polaris, Polarity, Microsoft Edge, QQ Browser, Qutebrowser, QupZilla, Rekonq, RockMelt, Samsung Browser, Sailfish Browser, SEMC-Browser, Sogou Explorer, Safari, Shiira, Skyfire, Seraphic Sraf, Sleipnir, SeaMonkey, SnowshoeSunrise, SuperBird, Streamy, Swiftfox, Tizen Browser, TweakStyle, UC Browser, Vivaldi, Vision Mobile Browser, WebPositive, Waterfox, wOSBrowser, WeTab Browser, Yandex Browser, Xiino"
},
"block_browser": {
"type": "string",
"description": "360 Phone Browser, 360 Browser, Avant Browser, ABrowse, ANT Fresco, ANTGalio, Aloha Browser, Amaya, Amigo, Android Browser, Arora, Amiga Voyager, Amiga Aweb, Atomic Web Browser, BlackBerry Browser, Baidu Browser, Baidu Spark, Beonex, Bunjalloo, B-Line, Brave, BriskBard, BrowseX, Camino, Coc Coc, Comodo Dragon, Coast, Charon, Chrome Frame, Chrome, Chrome Mobile iOS, Conkeror, Chrome Mobile, CoolNovo, CometBird, ChromePlus, Chromium, Cyberfox, Cheshire, dbrowser, Deepnet Explorer, Dolphin, Dorado, Dooble, Dillo, Epic, Elinks, Element Browser, GNOME Web, Espial TV Browser, Firebird, Fluid, Fennec, Firefox, Flock, Firefox Mobile, Fireweb, Fireweb Navigator, Galeon, Google Earth, HotJava, Iceape, IBrowse, iCab, iCab Mobile, Iridium, IceDragon, Isivioo, Iceweasel, Internet Explorer, IE Mobile, Iron, Jasmine, Jig Browser, Kindle Browser, K-meleon, Konqueror, Kapiko, Kylo, Kazehakase, Liebao, LG Browser, Links, LuaKit, Lunascape, Lynx, MicroB, NCSA Mosaic, Mercury, Mobile Safari, Midori, MIUI Browser, Mobile Silk, Maxthon, Nokia Browser, Nokia OSS Browser, Nokia Ovi Browser, NetFront, NetFront Life, NetPositive, Netscape, Obigo, Odyssey, Web Browser, Off By One, ONE Browser, Opera Mini, Opera Mobile, Opera, Opera Next, Oregano, Openwave Mobile Browser, OmniWeb, Otter Browser, Palm Blazer, Pale Moon, Palm Pre, Puffin, Palm WebPro, Palmscape, Phoenix, Polaris, Polarity, Microsoft Edge, QQ Browser, Qutebrowser, QupZilla, Rekonq, RockMelt, Samsung Browser, Sailfish Browser, SEMC-Browser, Sogou Explorer, Safari, Shiira, Skyfire, Seraphic Sraf, Sleipnir, SeaMonkey, SnowshoeSunrise, SuperBird, Streamy, Swiftfox, Tizen Browser, TweakStyle, UC Browser, Vivaldi, Vision Mobile Browser, WebPositive, Waterfox, wOSBrowser, WeTab Browser, Yandex Browser, Xiino"
},
"target_isp": {
"type": "string",
"description": "Allow specific ISP"
},
"block_isp": {
"type": "string",
"description": "Block specific ISP"
},
"events": {
"properties": {
"0": {
"properties": {
"event_name": {
"type": "string",
"description": "Name of the event"
},
"event_token": {
"type": "string",
"description": "Token for the event"
}
},
"required": [],
"type": "object"
}
},
"required": [],
"type": "object"
},
"RAW_BODY": {
"type": "string"
}
}
}
}
}
},
"deprecated": false
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true,
"_id": "62b9a01fc57d1f0097685af8:62b9a0cc210d3c04b1f20563"
}
```