Offer18 Knowledge Base
  • Welcome!
  • Network
    • Offers
      • Create New Offer
      • Advertiser URL Builder
      • Tracking URL Macros
      • Offer - General
      • Offer - Targeting
      • Offer - Targeting Rules
      • Offer - Creatives
      • Offer - Assign Affiliates
      • Offer - Capping Rules
      • Offer - Events
      • Offer - Payout Rules
      • Offer - Anti-Fraud
      • Offer - Fallback / JS Integration
      • Create CPS offer
      • Revenue Share Offer
      • Smart Offer
      • Deep Link
      • Pre-landing Page
      • Offer Categories
      • Coupons
      • Suppression List
      • Retargeting Tag
    • Affiliates
      • Create Affiliate
      • Affiliate Profile
      • Affiliate Employee
      • Manage Affiliates
      • Manage Offers
      • Generate Tracking URL
      • Affiliate Global Postback
      • Affiliate Postback Test
      • API Access Manage
      • Log in Affiliate Account
      • Reset Password
      • Affiliate Referrals
    • Advertisers
      • Create Advertiser
      • Advertiser Profile
      • Advertiser's Offers
      • Advertiser Test Link
      • Login as Advertiser
      • Password Reset
    • Postback Integration
    • Integration
      • Shopify
      • Cookieless integration with Shopify
      • WooCommerce
      • Cookieless integration with WooCommerce
    • Mobile Attribution Integration
      • AppsFlyer
        • Global Attribution URL
        • AppsFlyer Normal Postback
        • Advanced Privacy Postback
        • AppsFlyer - Click Signing
      • Adjust
      • Branch
      • Singular
      • Kochava
    • Reports
      • Reports
      • Reports - KPI
      • Reports - Templates
      • Conversion Logs
      • Affiliate Postback Logs
      • Advertiser Postback Logs
      • Capping Logs
    • Account Configuration
      • General Settings
      • Tracking Settings
      • Custom Appearance
      • SMTP Settings
      • Affiliate Settings
      • Advertiser Settings
    • Employees
      • Create Employee Account
      • Custom - Permissions
      • Clone Permissions
      • Additional Access
    • Tools
      • Mailer
      • Import Data
        • Import Affiliates
        • Import Affiliate Postback
        • Import Advertisers
        • Import Offers
        • Import Conversions
      • Offer Sync
        • Offer Sync Guide
        • Sync Logs
      • Product Feed
      • Automation
      • Link Tester
      • Fraud Detection
        • Fraud Fender
        • Conversion Risk Monitor
        • 3rd Party Integrations
    • Network API
      • Offers API
      • Offer Create API
      • Conversion API
      • Reports API
      • Affiliate & Advertiser Login API
      • Affiliate & Advertiser Create API
      • Affiliate & Advertiser Password Reset
      • OTP API
    • FAQ's
      • How to define event price in Payout Rule?
      • How to define affiliate specific payout in Payout Rules?
      • How to view Click logs?
      • What are different status in Advertiser Postback logs?
      • Why Domain have been flagged for SPAM?
      • What are different Affiliate Tracking URL Parameters?
    • SDK
      • Web SDK
      • Cookieless Tracking
      • Android SDK
      • Node SDK
    • Probabilistic Attribution
  • Universal
    • IPs Whitelist
    • Common Values
  • Affiliate
    • Affiliate API's
      • Offers API
      • Request Offer API
      • Reports API
      • Coupon API
      • SDK - Affiliate Offer Table
    • Integration
      • Google Ads Integration
      • Google Ads Integration - Web SDK
      • Offer18 - Zapier - Google Ads
      • Facebook Ads Integration
      • Facebook Conversion API
      • TikTok Event API
      • Snapchat Conversion API
    • Deep Link
    • Referral Program
  • iGaming
    • iGaming - Create Offer
    • iGaming - Events
    • iGaming - Reports
    • iGaming - Postback
    • iGaming - API
      • User API
      • Activity API
    • iGaming - SDK
      • WebSDK
Powered by GitBook
On this page
  • Common Parameters
  • Fields
  • Example API Request

Was this helpful?

  1. Network
  2. Network API

Offer Create API

PreviousOffers APINextConversion API

Last updated 24 days ago

Was this helpful?

POST https://api.offer18.com/api/m/offer_create

Common Parameters

Query

Type

Description

mid

Integer

Network Account ID

api-key

String

Network API Key

secret-key

String

Network Secret Key

Action

Query

Type

Description

type

String

Allowed Values: create / update

oid

Integer

Required in Offer Update


Fields

Body

Type

Description

offer_name

String

Name of the Campaign

advertiser_id

Integer

Advertiser ID

offer_url

URL

Campaign's URL

external_offer_id

String

External Campaign id (if any)

app_id

String

App id (if any)

logo

URL

URL of the Campaign's logo

category

String

Category of the Campaign

preview_url

URL

Preview URL of the Campaign

currency

String

Currency of the Offer

price_advertiser

Decimal

Price given by Advertiser for Campaign

price_affiliate

Decimal

Price given to Affiliate for Campaign

model_advertiser

String

model_affiliate

String

hide_affiliate_payout

Integer

Allowed values 1: To hide Affiliate Payout

start_datetime

Timestamp UTC

Start date / time (YYYY-MM-DD HH:MM:SS)

end_datetime

Timestamp UTC

End date / time (YYYY-MM-DD HH:MM:SS )

visibility

String

Allowed values: public, permission, private

status

String

Allowed values: approve, pending

deep_links

Integer

Allowed values 1: To enable deeplinks in Offers

offer_terms

String

Terms of the Campaign

offer_kpi

String

KPI terms of the Campaign

private_note

String

Private Notes in Campaign

imps_url

URL

Impression URL

landing_page_name_1

String

Name of the first landing page

landing_page_url_1

URL

URL of the first landing page for the Campaign

landing_page_name_2

String

Name of the second landing page

landing_page_url_2

URL

URL of the second landing page for the Campaign

creatives

URL

URL of the Creatives for the Campaign

fallback

boolean

Allowed values: 1: To enable Fallback

fallback_offer_id

Integer

Fallback's Offer ID

fallback_url

URL

URL of the Fallback

fraud_conv_speed

Integer

Time in seconds

proxy_block

Integer

Allowed values: 1: To block proxies

blank_ref_block

Integer

Allowed values: 1: To block blank Reference

hide_referral

Integer

Allowed values: 1: To hide referral

assign_affiliates

Integer

Assign Affiliates to this Campaign (Comma-separated values)

capping_rule_id

String

In case user wants to Update existing capping rule

capping[0][capping_rule_name]

String

Capping Rule Name

capping[0][capping_rule_type]

String

Type of capping rule 1. advertiser_capping 2. affiliate_capping

capping[0][capping_timezone]

Timestamp

Capping Timezone

capping[0][capping_events]

String

Capping events

capping[0][capping_type]

String

Type 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]

String

Capping period 1. daily 2. weekly 3. monthly 4. hourly

capping[0][capping_value]

Integer

Capping Value

capping[0][overcap_action]

String

Overcap Action 1. stop 2. fallback 3. fallback_conversion_accept 4. conversion_accept 5. conversion_reject 6. conversion_pending

capping[0][capping_notification_email]

Stirng

Capping Notification Email

capping[0][capping_affiliate_visibility]

Integer

1: To Show Capping Rule to affiliate

capping[0][capping_affiliate_id]

Stirng

Affiliate ID's (Comma seperated)

target_country

String

block_country

String

target_os

String

block_os

String

target_device

String

block_device

String

target_browser

String

block_browser

String

target_isp

String

Allow specific ISP

block_isp

String

Block specific ISP

events[0][event_name]

String

Name of the event

events[0][event_token]

String

Token for the event

capping_conversion_period

String

Depreciated

capping_budget

Integer

Depreciated

capping_conversion

Integer

Depreciated

capping_budget_period

String

Depreciated

Capping Rules (Instructions)

  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]

Events (Instructions)

  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]


Example API Request

Offer Create

API Response

{
    "status": "200",
    "response": "offer_created_successfully",
    "offer_id": 000012    
}

Offer Update

API Response

{
    "status": "200",
    "response": "offer_updated_successfully",
    "offer_id": "000001"
}


For secure interactions, always call the API from the server-side.

Advertiser Model of Campaign

Advertiser Model of Campaign

Allow specific Country

Block specific Country

Allow specific Operating system

Block specific Operating system

Allow specific Devices

Block specific Devices

Allow specific Browser

Block specific Browser

🔗
Click to Test Offer Create API
🔗
🔗
🔗
🔗
🔗
🔗
🔗
🔗
🔗
🔗
🔗
View Currencies
View Models
View Models
View Countries
View Countries
View OS
View OS
View Devices
View Devices
View Browsers
View Browsers