Skip to main content
PUT
Update custom param

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.

id
integer
required

Custom param ID.

Body

application/json
status
integer

Custom parameter status to set: 1=active, 3=inactive.

start_date
string

Start date (YYYY-MM-DD format).

end_date
string

End date (YYYY-MM-DD format), or an empty string to drop the end date.

affiliates
string

Comma-separated affiliate IDs the rule is limited to (an array of ids is also accepted). Leave empty to apply the rule to every affiliate of the offer.

conditions
object[]

Targeting conditions, AND-ed together. Send an empty array to apply the rule to all traffic of the selected affiliates.

parameters
object[]

The overrides applied when the rule matches — one entry per action.

Response

Custom param updated.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object