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
tags:
  - name: Custom Payout/Revenue
paths:
  /networks/custom/payoutrevenuetable:
    post:
      summary: Find Custom Payout & Revenues (Advanced)
      tags:
        - Custom Payout/Revenue
      parameters:
        - in: query
          name: page
          schema:
            type: integer
            default: 1
          description: Page number (1-based).
        - in: query
          name: page_size
          schema:
            type: integer
            default: 50
          description: Number of results per page.
        - in: query
          name: relationship
          schema:
            type: string
            enum:
              - offer
              - affiliates
              - limited_affiliates
              - payout_revenue_event_name
              - offer_urls
              - all
          description: >
            Include related data. Use `offer` for offer details,
            `affiliates` for full affiliate list, `limited_affiliates`
            for up to 5 affiliates, `payout_revenue_event_name` for the
            base event name, `offer_urls` for associated offer URLs, or
            `all` for everything. Repeat the parameter for multiple values.
        - in: query
          name: order_field
          schema:
            type: string
            enum:
              - id
              - name
              - relationship.offer.name
              - time_created
              - time_saved
          description: Field to order results by.
        - in: query
          name: order_direction
          schema:
            type: string
            enum:
              - asc
              - desc
          description: Sort direction.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                search_terms:
                  type: array
                  description: Text search filters.
                  items:
                    type: object
                    properties:
                      search_type:
                        type: string
                        enum:
                          - name
                          - offer
                          - affiliate
                        description: >
                          The field to search on. `name` searches by setting
                          ID or name, `offer` searches by offer ID or name,
                          `affiliate` searches by affiliate ID or name.
                      value:
                        type: string
                        description: The search value.
                filters:
                  type: object
                  description: Structured filters to narrow results.
                  properties:
                    custom_payout_revenue_status:
                      type: string
                      enum:
                        - active
                        - inactive
                      description: Filter by setting status.
                    network_offer_ids:
                      type: array
                      items:
                        type: integer
                      description: Filter by offer IDs.
                    network_affiliate_ids:
                      type: array
                      items:
                        type: integer
                      description: Filter by affiliate IDs.
            example:
              search_terms: []
              filters: {}
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                properties:
                  custom_payout_revenue_settings:
                    type: array
                    items:
                      type: object
                      properties:
                        network_custom_payout_revenue_setting_id:
                          type: integer
                        network_id:
                          type: integer
                        network_offer_id:
                          type: integer
                        network_offer_payout_revenue_id:
                          type: integer
                        name:
                          type: string
                        custom_setting_status:
                          type: string
                        is_apply_all_affiliates:
                          type: boolean
                        is_custom_payout_enabled:
                          type: boolean
                        payout_type:
                          type: string
                        payout_amount:
                          type: number
                          format: double
                        payout_percentage:
                          type: number
                        is_custom_revenue_enabled:
                          type: boolean
                        revenue_type:
                          type: string
                        revenue_amount:
                          type: number
                          format: double
                        revenue_percentage:
                          type: number
                        is_postback_disabled:
                          type: boolean
                        description:
                          type: string
                        public_description:
                          type: string
                        date_valid_from:
                          type: string
                        date_valid_to:
                          type: string
                        is_apply_specific_offer_urls:
                          type: boolean
                        network_affiliate_ids:
                          type: array
                          nullable: true
                          items:
                            type: integer
                        network_offer_url_ids:
                          type: array
                          nullable: true
                          items:
                            type: integer
                        time_created:
                          type: integer
                          example: 1734455015
                        time_saved:
                          type: integer
                          example: 1734455015
                        relationship:
                          type: object
                          properties:
                            affiliates:
                              type: object
                              description: >
                                Associated affiliates. Included with `relationship=affiliates`,
                                `relationship=limited_affiliates`, or `relationship=all`.
                                The `limited_affiliates` variant returns up to 5 entries.
                              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
                            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_event_name:
                              type: string
                              description: The name of the base payout/revenue event (e.g. `Base`, `Base Conversion`).
                            offer_urls:
                              type: array
                              description: Associated offer URLs (when `is_apply_specific_offer_urls` is `true`).
                              items:
                                type: object
                                properties:
                                  network_offer_url_id:
                                    type: integer
                                  network_id:
                                    type: integer
                                  network_offer_id:
                                    type: integer
                                  name:
                                    type: string
                  paging:
                    type: object
                    properties:
                      page:
                        type: integer
                      page_size:
                        type: integer
                      total_count:
                        type: integer
      security:
        - API Key: []
  /networks/custom/payoutrevenue:
    get:
      summary: List Custom Payout/Revenue
      tags:
        - Custom Payout/Revenue
      parameters:
        - in: query
          name: relationship
          schema:
            type: string
            enum:
              - all
          description: Set to `all` to include expanded relationship data (`ruleset`, `variables`, `offer_urls`) in the response. Without this parameter, only `affiliates`, `offer`, `payout_revenue`, and `currency_id` are returned.
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                properties:
                  custom_payout_revenue_settings:
                    type: array
                    items:
                      $ref: "#/components/schemas/CustomPayoutRevenue"
      security:
        - API Key: []
    post:
      summary: Create Custom Payout/Revenue
      tags:
        - Custom Payout/Revenue
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomPayoutRevenueInput"
            examples:
              basic:
                summary: "Custom CPA payout for specific affiliates"
                value:
                  network_offer_payout_revenue_id: 0
                  network_offer_id: 1
                  name: "VIP Partner Rate"
                  custom_setting_status: "active"
                  is_apply_all_affiliates: false
                  network_affiliate_ids:
                    - 7
                    - 14
                  is_custom_payout_enabled: true
                  payout_type: "cpa"
                  payout_amount: 5.00
                  payout_percentage: 0
                  is_custom_revenue_enabled: false
                  revenue_type: "blank"
                  revenue_amount: 0
                  revenue_percentage: 0
              revshare:
                summary: "Revenue share with date range"
                value:
                  network_offer_payout_revenue_id: 0
                  network_offer_id: 3
                  name: "Q1 Promo Rate"
                  custom_setting_status: "active"
                  is_apply_all_affiliates: false
                  network_affiliate_ids:
                    - 21
                  is_custom_payout_enabled: true
                  payout_type: "cpa_cps"
                  payout_amount: 2.00
                  payout_percentage: 10
                  is_custom_revenue_enabled: true
                  revenue_type: "rpa_rps"
                  revenue_amount: 4.00
                  revenue_percentage: 15
                  date_valid_from: "2026-01-01"
                  date_valid_to: "2026-03-31"
              with_variables:
                summary: "Per-product SKU pricing with variables"
                value:
                  network_offer_payout_revenue_id: 0
                  network_offer_id: 5
                  name: "Premium Product Rate"
                  custom_setting_status: "active"
                  is_apply_all_affiliates: true
                  is_custom_payout_enabled: true
                  payout_type: "cpa"
                  payout_amount: 15.00
                  payout_percentage: 0
                  is_custom_revenue_enabled: false
                  revenue_type: "blank"
                  revenue_amount: 0
                  revenue_percentage: 0
                  variables:
                    - variable: "sub1"
                      variable_value: "premium_sku"
                      comparison_method: "exact_match"
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CustomPayoutRevenue"
      security:
        - API Key: []
    patch:
      summary: Bulk Update Custom Payout/Revenue
      tags:
        - Custom Payout/Revenue
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BulkUpdateRequest"
            example:
              network_custom_payout_revenue_setting_ids:
                - 1
                - 2
                - 3
              fields:
                - field_type: "payout_amount"
                  field_value: 7.50
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
      security:
        - API Key: []
  /networks/custom/payoutrevenue/{settingId}:
    get:
      summary: Get Custom Payout/Revenue by ID
      description: >
        Retrieve a single custom payout/revenue setting by its ID.
      tags:
        - Custom Payout/Revenue
      parameters:
        - in: path
          name: settingId
          required: true
          schema:
            type: integer
          description: The custom payout/revenue setting identifier.
        - in: query
          name: relationship
          schema:
            type: string
            enum:
              - all
          description: Set to `all` to include expanded relationship data (`ruleset`, `variables`, `offer_urls`) in the response.
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CustomPayoutRevenue"
      security:
        - API Key: []
    put:
      summary: Update Custom Payout/Revenue
      description: >
        Update an existing custom payout/revenue setting.
      tags:
        - Custom Payout/Revenue
      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.50
              payout_percentage: 0
              is_custom_revenue_enabled: true
              revenue_type: "rpa"
              revenue_amount: 12.00
              revenue_percentage: 0
            schema:
              $ref: "#/components/schemas/CustomPayoutRevenueInput"
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CustomPayoutRevenue"
      security:
        - API Key: []
    delete:
      summary: Delete Custom Payout/Revenue
      tags:
        - Custom Payout/Revenue
      parameters:
        - in: path
          name: settingId
          required: true
          schema:
            type: integer
          description: The custom payout/revenue setting identifier.
      responses:
        "200":
          description: ""
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
      security:
        - API Key: []
components:
  schemas:
    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.
    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.
    BulkUpdateRequest:
      type: object
      required:
        - network_custom_payout_revenue_setting_ids
        - fields
      properties:
        network_custom_payout_revenue_setting_ids:
          type: array
          items:
            type: integer
          description: List of custom payout/revenue setting IDs to update.
        fields:
          type: array
          items:
            type: object
            properties:
              field_type:
                type: string
                enum:
                  - custom_setting_status
                  - date_valid_from
                  - date_valid_to
                  - description
                  - is_apply_all_affiliates
                  - is_custom_payout_enabled
                  - is_custom_revenue_enabled
                  - public_description
                  - name
                  - network_affiliate_ids
                  - network_offer_id
                  - payout_amount
                  - payout_percentage
                  - payout_type
                  - revenue_amount
                  - revenue_percentage
                  - revenue_type
                  - is_postback_disabled
                  - variables
                  - ruleset_platforms
                  - ruleset_device_types
                  - ruleset_os_versions
                  - ruleset_browsers
                  - ruleset_languages
                  - ruleset_countries
                  - ruleset_regions
                  - ruleset_cities
                  - ruleset_dmas
                  - ruleset_mobile_carriers
                  - ruleset_isps
                  - ruleset_connection_types
                  - ruleset_ips
                  - ruleset_is_block_proxy
                  - ruleset_brands
                  - ruleset_postal_codes
                description: >
                  The field to update. Note that `is_apply_all_affiliates`
                  can only be bulk-updated to `true`. Switching to specific
                  affiliates requires using the PUT endpoint instead, because
                  `is_apply_all_affiliates` and `network_affiliate_ids`
                  cannot be set atomically via bulk update.
              field_value:
                description: The new value for the field.
  securitySchemes:
    API Key:
      description: The Everflow API key generated from the Control Center > Security.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey