Skip to main content
POST
Create offer

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

application/json
title
string
required

Offer title (max 128 characters).

Maximum string length: 128
advertiser_id
integer
required

Advertiser ID. Create: POST /api/v2/network/advertisers.

visible_type
integer
required

1=private, 2=public, 3=require_approval.

default_url
string
required

Default landing page URL. Auto-creates default landing page.

status
integer

Offer status to set: 1=active, 2=testing, 3=inactive, 6=draft. 5=deleted is rejected on create and only accepted when updating an existing offer.

currency
string

ISO 4217 currency code.

Maximum string length: 3
external_id
string

External identifier for integration.

description
string

Public offer description.

internal_info
string

Internal notes (not visible to affiliates).

timezone
string

Timezone identifier used to determine whether expiration_date is in the past.

Maximum string length: 32
image
string

Image URL.

image_data
string

Base64-encoded image data.

Mark as featured: 1=yes, 0=no.

Available options:
0,
1
is_expires
enum<integer>

Enable expiration: 1=yes, 0=no.

Available options:
0,
1
expiration_date
string

Expiration date in Y-m-d format. When is_expires=1, must be today or a future date in the offer timezone.

ask_approval_questions
enum<integer>

Require approval questions: 1=yes, 0=no.

Available options:
0,
1
questions
string

Approval questions configuration.

categories
string

Comma-separated category IDs.

categories_ids
integer[]
tags
integer[]

Array of tag IDs.

traffic_types
integer[]

Array of traffic type IDs.

traffic_types_denied
integer[]
preview_url
string
goal_type
integer

Default goal type ID.

goal_title
string
goal_revenue
number
goal_payout
number
block_traffic
enum<integer>
Available options:
0,
1
block_traffic_vpn
enum<integer>
Available options:
0,
1
block_traffic_proxy
enum<integer>
Available options:
0,
1
block_traffic_bot
enum<integer>
Available options:
0,
1

Response

Offer created.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object