Skip to main content
POST
Create goal

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.

Path Parameters

offer_id
integer
required

Offer ID.

Body

application/json
title
string
required
Maximum string length: 128
type
integer
required

Goal type ID.

status
integer
required

1=active, 3=inactive.

tracking_method
integer
required

1=postback, 2=pixel.

revenue
number
required
payout
number
required
conversion_status
integer

2=approved, 3=pending.

multiple_conversions
enum<integer>
Available options:
0,
1
is_private
enum<integer>
Available options:
0,
1
alias
string

Goal alias (alphanumeric and underscores only).

Maximum string length: 64
hold_period
string

Response

Goal created.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object