> ## Documentation Index > Fetch the complete documentation index at: https://developers.everflow.io/llms.txt > Use this file to discover all available pages before exploring further. # Update Custom Payout/Revenue > Update an existing custom payout/revenue setting. ## OpenAPI ````yaml openapi/custom-payout-revenue.yaml put /networks/custom/payoutrevenue/{settingId} openapi: 3.0.3 info: title: Everflow Network API - Custom Payout/Revenue description: > Endpoints for managing custom payout and revenue settings in the Everflow network. Custom payout/revenue settings let you create partner-specific payout or revenue rules that override the offer's base rates — if multiple custom settings exist, Everflow applies the most specific one. For an overview, see the [Custom Settings guide](https://helpdesk.everflow.io/customer/overview-of-custom-settings). version: 1.0.0 servers: - url: https://api.eflow.team/v1 security: [] tags: - name: Custom Payout/Revenue paths: /networks/custom/payoutrevenue/{settingId}: put: tags: - Custom Payout/Revenue summary: Update Custom Payout/Revenue description: | Update an existing custom payout/revenue setting. parameters: - in: path name: settingId required: true schema: type: integer description: The custom payout/revenue setting identifier. requestBody: required: true content: application/json: example: network_offer_payout_revenue_id: 0 network_offer_id: 1 name: VIP Partner Rate - Updated custom_setting_status: active is_apply_all_affiliates: false network_affiliate_ids: - 7 is_custom_payout_enabled: true payout_type: cpa payout_amount: 7.5 payout_percentage: 0 is_custom_revenue_enabled: true revenue_type: rpa revenue_amount: 12 revenue_percentage: 0 schema: $ref: '#/components/schemas/CustomPayoutRevenueInput' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CustomPayoutRevenue' security: - API Key: [] components: schemas: CustomPayoutRevenueInput: type: object required: - network_offer_payout_revenue_id - network_offer_id - name - custom_setting_status - is_apply_all_affiliates - payout_amount - payout_percentage - payout_type - revenue_amount - revenue_percentage - revenue_type properties: network_offer_payout_revenue_id: type: integer description: > The offer's payout/revenue configuration ID. Use `0` for the base conversion. For event-level custom payouts, use the specific event ID. network_offer_id: type: integer description: The offer ID to create this custom setting for. name: type: string description: Display name for this custom payout/revenue setting. custom_setting_status: type: string enum: - active - inactive description: Setting status. is_apply_all_affiliates: type: boolean description: > Whether this setting applies to all affiliates, including ones who have yet to be created. If `false`, you must specify `network_affiliate_ids`. network_affiliate_ids: type: array items: type: integer description: > Array of affiliate IDs this setting applies to. Required when `is_apply_all_affiliates` is `false`. is_custom_payout_enabled: type: boolean description: > Whether custom payout is enabled. At least one of `is_custom_payout_enabled` or `is_custom_revenue_enabled` must be `true`. payout_type: type: string enum: - blank - cpc - cpa - cpm - cps - cpa_cps - prv - cpa_sku - cps_sku - cpa_cps_sku - prv_sku description: > Payout pricing model. Use `blank` when `is_custom_payout_enabled` is `false`. `cpc` = cost per click, `cpa` = cost per action, `cpm` = cost per mille, `cps` = cost per sale (percentage), `cpa_cps` = CPA + CPS hybrid, `prv` = private (hidden from affiliates). The `_sku` variants are used for Price Per Product offers where SKU variables are specified. payout_amount: type: number format: double description: >- Custom payout amount. Only relevant for a `payout_type` expressed in absolute values (`cpa`, `cpa_cps`, `cpm`, `cpc`). payout_percentage: type: number description: >- Payout percentage. Only relevant for a `payout_type` expressed in percentage (`cps`, `cpa_cps`, `prv`). is_custom_revenue_enabled: type: boolean description: > Whether custom revenue is enabled. At least one of `is_custom_payout_enabled` or `is_custom_revenue_enabled` must be `true`. revenue_type: type: string enum: - blank - rpc - rpa - rpm - rps - rpa_rps - rpa_sku - rps_sku - rpa_rps_sku description: > Revenue pricing model. Use `blank` when `is_custom_revenue_enabled` is `false`. `rpc` = revenue per click, `rpa` = revenue per action, `rpm` = revenue per mille, `rps` = revenue per sale (percentage), `rpa_rps` = RPA + RPS hybrid. The `_sku` variants are used for Price Per Product offers where SKU variables are specified. revenue_amount: type: number format: double description: >- Custom revenue amount. Only relevant for a `revenue_type` expressed in absolute values (`rpa`, `rpa_rps`, `rpm`, `rpc`). revenue_percentage: type: number description: Revenue percentage (used with `rps` and `rpa_rps` types). description: type: string description: Internal description (visible only to network users). public_description: type: string description: >- Public description visible to affiliates. Note that if the custom payout revenue completely overrides the base payout revenue settings (not regulated by dates, targeting, or variable rules), it will not appear as a "custom payout" setting for the affiliate, and this description will not be visible. is_postback_disabled: type: boolean description: >- Whether to disable partner postback firing when this custom setting takes effect. When `true`, partner postbacks will not fire for conversions matched by this setting. date_valid_from: type: string description: >- Start date for when this setting is active (YYYY-MM-DD). The custom setting will not apply before this date. Leave empty for no start date restriction. date_valid_to: type: string description: >- End date for when this setting expires (YYYY-MM-DD). The custom setting will not apply after this date. Leave empty for no end date restriction. is_apply_specific_offer_urls: type: boolean description: Whether this setting only applies to specific offer URLs. network_offer_url_ids: type: array items: type: integer description: > Array of offer URL IDs this setting applies to. Used when `is_apply_specific_offer_urls` is `true`. ruleset: type: object description: > Targeting ruleset for this custom payout/revenue setting. Allows you to restrict when this custom payout/revenue is applied based on geographic, device, browser, and connection criteria. See the [Ruleset guide](/user-guide/rulesets) for details. variables: type: array description: > Goal condition variables that must match for this custom payout/revenue to take effect. Variables can be used for parameter-based goals or Products/SKU pricing. Each variable defines a condition based on tracking parameters. For SKU-based pricing, see the [Price Per Product guide](https://helpdesk.everflow.io/customer/how-to-set-up-price-per-product). items: type: object required: - variable - variable_value - comparison_method properties: variable: type: string description: > The parameter to match. Existing parameters include `sub1` through `sub10`, `adv1` through `adv10`, `sale_amount`, and `source_id`. You can also use any custom parameter name. For Price Per Product offers, use `sku`. variable_value: type: string description: The value to compare against. variable_secondary_value: type: string description: >- A secondary value used with range-based comparison methods (e.g. `between`). comparison_method: type: string enum: - exact_match - contains - begins_with - ends_with - equals - greater_than - greater_than_or_equal - less_than - less_than_or_equal - is_present - not_present - between description: How to compare the variable against the value. CustomPayoutRevenue: type: object properties: network_custom_payout_revenue_setting_id: type: integer description: Unique custom payout/revenue setting ID. network_id: type: integer description: Network ID. network_offer_id: type: integer description: Associated offer ID. network_offer_payout_revenue_id: type: integer description: The offer's payout/revenue config ID (0 = base conversion). name: type: string description: Display name for this custom setting. custom_setting_status: type: string enum: - active - inactive description: Setting status. is_apply_all_affiliates: type: boolean description: >- Whether this setting applies to all affiliates, including ones who have yet to be created. is_custom_payout_enabled: type: boolean description: Whether custom payout is enabled. payout_type: type: string enum: - blank - cpc - cpa - cpm - cps - cpa_cps - prv - cpa_sku - cps_sku - cpa_cps_sku - prv_sku description: Payout pricing model. `blank` when custom payout is not enabled. payout_amount: type: number format: double description: >- Custom payout amount. Only relevant for a `payout_type` expressed in absolute values (`cpa`, `cpa_cps`, `cpm`, `cpc`). payout_percentage: type: number description: >- Payout percentage. Only relevant for a `payout_type` expressed in percentage (`cps`, `cpa_cps`, `prv`). is_custom_revenue_enabled: type: boolean description: Whether custom revenue is enabled. revenue_type: type: string enum: - blank - rpc - rpa - rpm - rps - rpa_rps - rpa_sku - rps_sku - rpa_rps_sku description: Revenue pricing model. `blank` when custom revenue is not enabled. revenue_amount: type: number format: double description: >- Custom revenue amount. Only relevant for a `revenue_type` expressed in absolute values (`rpa`, `rpa_rps`, `rpm`, `rpc`). revenue_percentage: type: number description: Revenue percentage. description: type: string description: Internal description. public_description: type: string description: >- Public description visible to affiliates. Note that if the custom payout revenue completely overrides the base payout revenue settings (not regulated by dates, targeting, or variable rules), it will not appear as a "custom payout" setting for the affiliate, and this description will not be visible. is_postback_disabled: type: boolean description: >- Whether to disable partner postback firing when this custom setting takes effect. When `true`, partner postbacks will not fire for conversions matched by this setting. date_valid_from: type: string description: >- Start date for when this setting is active (YYYY-MM-DD). The custom setting will not apply before this date. Leave empty for no start date restriction. date_valid_to: type: string description: >- End date for when this setting expires (YYYY-MM-DD). The custom setting will not apply after this date. Leave empty for no end date restriction. is_apply_specific_offer_urls: type: boolean description: Whether this applies only to specific offer URLs. network_affiliate_ids: type: array items: type: integer description: Array of affiliate IDs this setting applies to. time_created: type: integer example: 1734455015 description: Unix timestamp of creation. time_saved: type: integer example: 1734455015 description: Unix timestamp of last update. network_offer_url_ids: type: array nullable: true items: type: integer description: Array of offer URL IDs this setting applies to. relationship: type: object properties: affiliates: type: object description: Associated affiliates with pagination. properties: total: type: integer description: Total number of associated affiliates. entries: type: array items: type: object properties: network_affiliate_id: type: integer network_id: type: integer name: type: string account_status: type: string network_employee_id: type: integer internal_notes: type: string has_notifications: type: boolean network_traffic_source_id: type: integer account_executive_id: type: integer adress_id: type: integer default_currency_id: type: string is_contact_address_enabled: type: boolean enable_media_cost_tracking_links: type: boolean time_created: type: integer example: 1734455015 time_saved: type: integer example: 1734455015 referrer_id: type: integer offer: type: object description: Associated offer details. properties: network_offer_id: type: integer network_id: type: integer network_advertiser_id: type: integer network_offer_group_id: type: integer name: type: string offer_status: type: string network_tracking_domain_id: type: integer visibility: type: string currency_id: type: string payout_revenue: type: object description: Associated payout/revenue configuration details. properties: network_offer_payout_revenue_id: type: integer network_id: type: integer network_offer_id: type: integer entry_name: type: string payout_type: type: string payout_amount: type: number format: double payout_percentage: type: number format: double revenue_type: type: string revenue_amount: type: number format: double revenue_percentage: type: number format: double is_default: type: boolean is_private: type: boolean is_postback_disabled: type: boolean is_enforce_caps: type: boolean time_created: type: integer example: 1734455015 global_advertiser_event_id: type: integer is_must_approve_conversion: type: boolean is_allow_duplicate_conversion: type: boolean is_email_attribution_default_event: type: boolean remote_offer_resource: type: object description: Remote offer resource details. currency_id: type: string description: Currency code for this custom payout/revenue setting. ruleset: type: object description: > Targeting ruleset applied to this setting. Contains geographic, device, browser, and connection targeting rules. See the [Ruleset guide](/user-guide/rulesets) for details. variables: type: object description: Variable matching rules for this setting. properties: total: type: integer description: Total number of variables. entries: type: array description: List of variable conditions. items: type: object properties: network_custom_payout_revenue_setting_variable_id: type: integer description: Unique variable ID. network_custom_payout_revenue_setting_id: type: integer description: The parent custom payout/revenue setting ID. comparison_method: type: string description: How to compare the variable against the value. variable: type: string description: The parameter name. variable_value: type: string description: The value to compare against. variable_secondary_value: type: string description: A secondary value used with range-based comparisons. offer_urls: type: array description: >- Associated offer URL details (included with `relationship=all` when `is_apply_specific_offer_urls` is `true`). items: type: object properties: network_offer_url_id: type: integer description: Unique offer URL ID. network_id: type: integer description: Network ID. network_offer_id: type: integer description: Offer ID. name: type: string description: Offer URL name. securitySchemes: API Key: description: The Everflow API key generated from the Control Center > Security. in: header name: X-Eflow-Api-Key type: apiKey ````