---
title: "Create Custom Scrub Rate"
method: POST
path: "/networks/custom/scrubrate"
tags: ["Custom Scrub Rates"]
---

# Create Custom Scrub Rate

`POST /networks/custom/scrubrate`

## Request body

- CustomScrubRateInput
  - `network_offer_id` integer, required — The offer ID to create this custom scrub rate for.
  - `network_affiliate_id` integer, required — The affiliate ID to apply this custom scrub rate to.
  - `name` string, 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_percentage` integer, 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.
  - `variables` object[] — Optional list of variables that control which traffic segments the scrub rate applies to. Each variable defines a condition that must match for this scrub rate setting to take effect.
    - `variable` 'sub1' | 'sub2' | 'sub3' | 'sub4' | 'sub5' | 'sub6' | 'sub7' | 'sub8' | 'sub9' | 'sub10' | 'source_id', required — The scrub rate variable name. Identifies which traffic parameter to evaluate.
    - `variable_value` string, required — The value to use for comparison against the variable.
    - `variable_secondary_value` string — A secondary value used with range-based comparison methods.
    - `comparison_method` 'exact_match' | 'contains' | 'begins_with' | 'ends_with' | 'is_present', required — The type of comparison to use when matching the variable against the specified value.
  - `ruleset` object — 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](/user-guide/rulesets) for details.

## Response `200`

- CustomScrubRate
  - `network_custom_scrub_rate_setting_id` integer — Unique custom scrub rate setting ID.
  - `network_id` integer — Network ID.
  - `network_offer_id` integer — Associated offer ID.
  - `network_affiliate_id` integer — Associated affiliate ID.
  - `name` string — Display name for this custom scrub rate setting.
  - `custom_setting_status` 'active' | 'inactive' — Setting status.
  - `scrub_rate_percentage` integer — 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_created` integer — Unix timestamp of creation.
  - `time_saved` integer — Unix timestamp of last update.
  - `relationship` object
    - `affiliate` object — Associated affiliate details.
      - `network_affiliate_id` integer
      - `network_id` integer
      - `name` string
      - `account_status` string
      - `network_employee_id` integer
      - `internal_notes` string
      - `has_notifications` boolean
      - `network_traffic_source_id` integer
      - `account_executive_id` integer
      - `adress_id` integer
      - `default_currency_id` string
      - `is_contact_address_enabled` boolean
      - `enable_media_cost_tracking_links` boolean
      - `time_created` integer
      - `time_saved` integer
      - `referrer_id` integer
    - `offer` object — Associated offer details.
      - `network_offer_id` integer
      - `network_id` integer
      - `network_advertiser_id` integer
      - `network_offer_group_id` integer
      - `name` string
      - `offer_status` string
      - `network_tracking_domain_id` integer
      - `visibility` string
      - `currency_id` string
    - `ruleset` object — Targeting ruleset applied to this setting. Contains geographic, device, browser, and connection targeting rules. See the [Ruleset guide](/user-guide/rulesets) for details.
    - `variables` object — Variable matching rules associated with this scrub rate setting.
      - `total` integer — Total number of variables.
      - `entries` object[] — List of variable conditions.
        - `network_custom_scrub_rate_setting_variable_id` integer — Unique variable ID.
        - `network_custom_scrub_rate_setting_id` integer — The parent custom scrub rate setting ID.
        - `comparison_method` string — How to compare the variable against the value.
        - `variable` string — The parameter name.
        - `variable_value` string — The value to compare against.
        - `variable_secondary_value` string — A secondary value used with range-based comparisons.

---

[API](https://skmtc.net/everflow/apis/everflow-network-api-tracking-domains.md) · [All operations](https://skmtc.net/everflow/apis/everflow-network-api-tracking-domains/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/everflow/everflow-network-api-tracking-domains/versions/39242cee0e32/schema)