# Offer Create API ``` POST https://api.offer18.com/api/m/offer_create ``` :link: [**Click to Test Offer Create API**](https://offer18.readme.io/reference/offers-api) ### Common Parameters | **Query** | **Type** | **Description** | | ---------- | -------- | ------------------ | | mid | Integer | Network Account ID | | api-key | String | Network API Key | | secret-key | String | Network Secret Key | **Action**
QueryTypeDescription
typeStringAllowed Values:
create / update
oidIntegerRequired in Offer Update
*** ### **Fields**
BodyTypeDescription
offer_nameStringName of the Campaign
advertiser_idIntegerAdvertiser ID
offer_urlURLCampaign's URL
external_offer_idStringExternal Campaign id (if any)
app_idStringApp id (if any)
logoURLURL of the Campaign's logo
categoryStringCategory of the Campaign
preview_urlURLPreview URL of the Campaign
currencyString

Currency of the Offer

🔗 View Currencies

price_advertiserDecimalPrice given by Advertiser for Campaign
price_affiliateDecimalPrice given to Affiliate for Campaign
model_advertiserStringAdvertiser Model of Campaign
🔗 View Models
model_affiliateStringAdvertiser Model of Campaign
🔗 View Models
hide_affiliate_payoutIntegerAllowed values
1: To hide Affiliate Payout
start_datetimeTimestamp UTCStart date / time
(YYYY-MM-DD HH:MM:SS)
end_datetimeTimestamp UTCEnd date / time
(YYYY-MM-DD HH:MM:SS )
visibilityStringAllowed values:
public, permission, private
statusStringAllowed values: approve, pending
deep_linksIntegerAllowed values
1: To enable deeplinks in Offers
offer_termsStringTerms of the Campaign
offer_kpiStringKPI terms of the Campaign
private_noteStringPrivate Notes in Campaign
imps_urlURLImpression URL
landing_page_name_1StringName of the first landing page
landing_page_url_1URLURL of the first landing page for the Campaign
landing_page_name_2StringName of the second landing page
landing_page_url_2URLURL of the second landing page for the Campaign
creativesURLURL of the Creatives for the Campaign
fallbackbooleanAllowed values:
1: To enable Fallback
fallback_offer_idIntegerFallback's Offer ID
fallback_urlURLURL of the Fallback
fraud_conv_speedIntegerTime in seconds
proxy_blockIntegerAllowed values:
1: To block proxies
blank_ref_blockIntegerAllowed values:
1: To block blank Reference
hide_referralIntegerAllowed values:
1: To hide referral
assign_affiliatesIntegerAssign Affiliates to this Campaign
(Comma-separated values)
capping_rule_idStringIn case user wants to Update existing capping rule
capping[0][capping_rule_name]StringCapping Rule Name
capping[0][capping_rule_type]StringType of capping rule
1. advertiser_capping
2. affiliate_capping
capping[0][capping_timezone]TimestampCapping Timezone
capping[0][capping_events]StringCapping events
capping[0][capping_type]StringType of capping
1. gross_conversions
2. approved_conversions
3. gross_revenue
4. approved_revenue
5. gross_payout
6. approved_payout
7. gross_clicks
8. approved_clicks
capping[0][capping_period]StringCapping period
1. daily
2. weekly
3. monthly
4. hourly
capping[0][capping_value]IntegerCapping Value
capping[0][overcap_action]StringOvercap Action
1. stop
2. fallback
3. fallback_conversion_accept
4. conversion_accept
5. conversion_reject
6. conversion_pending
capping[0][capping_notification_email]StirngCapping Notification Email
capping[0][capping_affiliate_visibility]Integer1: To Show Capping Rule to affiliate
capping[0][capping_affiliate_id]StirngAffiliate ID's (Comma seperated)
target_countryStringAllow specific Country
🔗 View Countries
block_countryStringBlock specific Country
🔗 View Countries
target_osStringAllow specific Operating system
🔗 View OS
block_osStringBlock specific Operating system
🔗 View OS
target_deviceStringAllow specific Devices
🔗 View Devices
block_deviceStringBlock specific Devices
🔗 View Devices
target_browserStringAllow specific Browser
🔗 View Browsers
block_browserStringBlock specific Browser
🔗 View Browsers
target_ispStringAllow specific ISP
block_ispStringBlock specific ISP
events[0][event_name]StringName of the event
events[0][event_token]StringToken for the event
capping_conversion_periodStringDepreciated
capping_budgetIntegerDepreciated
capping_conversionIntegerDepreciated
capping_budget_periodStringDepreciated
**Capping Rules (Instructions)** {% hint style="info" %} 1. If you want to set multiple capping rules, you can do it by assigning rules to different numbers\ **Example 1:** \ capping\[**1**]\[capping\_rule\_name] \ capping\[**1**]\[capping\_rule\_type]\ **Example 2:**\ capping\[**2**]\[capping\_rule\_name] \ capping\[**2**]\[capping\_rule\_type] 2. If you want to update existing capping rule, you must post **capping\_rule\_id** in API Request along with new data to **0**(Zero) number\ **Example:**\ capping\[**0**]\[capping\_rule\_name] \ capping\[**0**]\[capping\_rule\_type] {% endhint %} **Events (Instructions)** {% hint style="info" %} 1. If you want to create multiple events, you can do it by assigning events to different numbers\ **Example 1:** \ events\[1]\[event\_name] \ events\[1]\[event\_token]\ **Example 2:**\ events\[2]\[event\_name] \ events\[2]\[event\_token] {% endhint %} *** ### Example API Request **Offer Create** ![](https://295230641-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F41f2EboJipeUA6flsLGK%2Fuploads%2Fdx5QTRNVdSSn89Lmib9O%2Fimage.png?alt=media\&token=855f8e50-bbf1-4c8d-998d-2a0bf3133d67) **API Response** ``` { "status": "200", "response": "offer_created_successfully", "offer_id": 000012 } ``` **Offer Update** ![](https://295230641-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F41f2EboJipeUA6flsLGK%2Fuploads%2Fp9ZW5G3rU3gMmESmYWwY%2Fimage.png?alt=media\&token=ba10f54b-9203-4576-b029-139456429b94) **API Response** ``` { "status": "200", "response": "offer_updated_successfully", "offer_id": "000001" } ``` *** {% hint style="info" %} **For secure interactions, always call the API from the server-side.** {% endhint %}