Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Custom Scrub Rates

Update Custom Scrub Rate

put/networks/custom/scrubrate/{settingId}

Path parameters

settingIdinteger required

The custom scrub rate setting identifier.

Request body

network_offer_idinteger required

The offer ID to create this custom scrub rate for.

network_affiliate_idinteger required

The affiliate ID to apply this custom scrub rate to.

namestring required

The custom scrub rate setting name.

custom_setting_status'active' | 'inactive' required

The custom setting status. Can be either active or inactive.

scrub_rate_percentageinteger required

The percentage of conversions that will be affected by this setting (0-100). Note that each conversion has the specified percentage chance of being scrubbed, rather than guaranteeing that exactly that percentage will be scrubbed.

scrub_rate_status'rejected' | 'pending' required

Status to assign to scrubbed conversions. pending marks them as pending for review; rejected rejects them immediately.

rulesetobject

Targeting ruleset for this custom scrub rate setting. Allows you to restrict when this scrub rate is applied based on geographic, device, browser, and connection criteria. See the Ruleset guide for details.

Response

network_custom_scrub_rate_setting_idinteger

Unique custom scrub rate setting ID.

network_idinteger

Network ID.

network_offer_idinteger

Associated offer ID.

network_affiliate_idinteger

Associated affiliate ID.

namestring

Display name for this custom scrub rate setting.

custom_setting_status'active' | 'inactive'

Setting status.

scrub_rate_percentageinteger

The percentage of conversions that will be affected by this setting (0-100). Note that each conversion has the specified percentage chance of being scrubbed, rather than guaranteeing that exactly that percentage will be scrubbed.

scrub_rate_status'rejected' | 'pending'

How the setting affects the conversions it targets. pending marks conversions as pending; rejected rejects them immediately.

time_createdinteger

Unix timestamp of creation.

time_savedinteger

Unix timestamp of last update.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "affiliate": {
      "time_created": 1734455015,
      "time_saved": 1734455015
    }
  }
}