> ## 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.

# Create Offer

Create a new offer with full configuration. The payload is complex -- consider using the Copy Offer endpoint with a template instead of building from scratch.


## OpenAPI

````yaml openapi/offers.yaml post /networks/offers
openapi: 3.0.3
info:
  title: Everflow Network API - Offers
  description: >
    Offer management endpoints for the Everflow partner marketing platform.
    Search, retrieve, and manage offers. For a full overview of offers, see the
    [Offer Fundamentals
    guide](https://helpdesk.everflow.io/customer/what-is-an-offer).
  version: 1.0.0
servers:
  - description: Production Server
    url: https://api.eflow.team/v1
security: []
tags:
  - name: Offers
    description: Endpoints for searching and managing offers.
paths:
  /networks/offers:
    post:
      tags:
        - Offers
      summary: Create Offer
      requestBody:
        required: true
        content:
          application/json:
            example:
              offer_status: active
              redirect_mode: standard
              conversion_method: server_postback
              session_definition: cookie
              network_advertiser_id: 13
              name: My CPA Offer
              network_category_id: 1
              destination_url: https://example.com/offer?tid={transaction_id}
              currency_id: USD
              network_tracking_domain_id: 1
              visibility: public
              payout_revenue:
                - payout_type: cpa
                  payout_amount: 2.5
                  revenue_type: rpa
                  revenue_amount: 4
                  is_default: true
            schema:
              $ref: '#/components/schemas/OfferRequestBody'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Offer'
      security:
        - API Key: []
components:
  schemas:
    OfferRequestBody:
      type: object
      required:
        - offer_status
        - redirect_mode
        - conversion_method
        - session_definition
        - session_duration
        - network_advertiser_id
        - name
        - network_category_id
        - destination_url
        - currency_id
        - network_tracking_domain_id
        - visibility
        - is_view_through_enabled
        - is_caps_enabled
        - is_using_suppression_list
        - is_duplicate_filter_enabled
        - duplicate_filter_targeting_action
        - is_use_secure_link
        - is_allow_deep_link
        - is_session_tracking_enabled
        - is_fail_traffic_enabled
        - redirect_internal_routing_type
        - is_using_explicit_terms_and_conditions
        - is_force_terms_and_conditions
        - is_must_approve_conversion
        - is_allow_duplicate_conversion
        - payout_revenue
      properties:
        network_advertiser_id:
          type: integer
          description: ID of the advertiser submitting the offer.
        name:
          type: string
          description: Offer name.
        destination_url:
          type: string
          description: >-
            URL of the final landing page associated with the offer, including
            additional macros if applicable.
        currency_id:
          type: string
          description: Currency used to compute payouts, costs, and revenues of the offer.
        network_offer_group_id:
          type: integer
          description: Associated offer group.
        thumbnail_url:
          type: string
          description: >-
            URL of the image thumbnail associated with the offer, visible to
            network employees and affiliates.
        network_category_id:
          type: integer
          description: Category ID.
        internal_notes:
          type: string
          description: >-
            Notes on the offer for network employees. Not displayed to
            affiliates and advertisers.
        server_side_url:
          type: string
          description: >-
            Server-side URL that will be asynchronously fired by Everflow
            following a click.
        preview_url:
          type: string
          description: Landing page preview URL.
        html_description:
          type: string
          description: Description of the offer for the affiliates. HTML code is accepted.
        is_description_plain_text:
          type: boolean
          description: >-
            Whether the description of the offer should be interpreted as plain
            text (true) or HTML (false).
        offer_status:
          type: string
          enum:
            - active
            - paused
            - pending
            - deleted
          description: Offer status.
        visibility:
          type: string
          enum:
            - public
            - require_approval
            - private
          description: >-
            Visibility setting for affiliates. Can be `public`,
            `require_approval`, or `private`.
        project_id:
          type: string
          description: ID for the advertiser campaign or an Insertion Order.
        date_live_until:
          type: string
          description: >-
            Date until when the offer can be run. Events occurring past the end
            of the day at the timezone of the network will be rejected. Format:
            YYYY-MM-DD.
        app_identifier:
          type: string
          description: Bundle ID for iOS / Android apps.
        labels:
          type: array
          items:
            type: string
          description: Labels used for organizing offers by private internal keywords.
        caps_timezone_id:
          type: integer
          description: >-
            ID of the timezone used for the caps if it differs from the
            network's default.
        network_tracking_domain_id:
          type: integer
          description: ID of the tracking domain hit by clicks belonging to the offer.
        conversion_method:
          type: string
          enum:
            - server_postback
            - http_image_pixel
            - https_image_pixel
            - http_iframe_pixel
            - https_iframe_pixel
            - javascript
            - cookie_based
            - html_pixel_cookie_based
          description: >-
            Method used by the advertiser to fire tracking data to Everflow.
            Deprecated values (`http_image_pixel`, `https_image_pixel`,
            `cookie_based`, `http_iframe_pixel`, `https_iframe_pixel`) are
            normalized to `html_pixel_cookie_based`.
        redirect_mode:
          type: string
          enum:
            - standard
            - single_meta_refresh
            - double_meta_refresh
            - seo_friendly
          description: >-
            Setting used to obscure referrer URLs from advertisers. Non-standard
            modes (`single_meta_refresh`, `double_meta_refresh`) are not
            recommended as they cause click drop-off.
        redirect_routing_method:
          type: string
          enum:
            - unknown
            - internal
            - null_value
        session_definition:
          type: string
          enum:
            - cookie
            - ip
            - ip_user_agent
            - google_ad_id
            - idfa
          description: Method used for determining whether a click is unique.
        session_duration:
          type: integer
          description: >-
            Duration (in hours) of the active session used to match a click to a
            conversion. Defaults to 24.
        attribution_method:
          type: string
          enum:
            - first_touch
            - last_touch
        is_soft_cap:
          type: boolean
          description: Whether soft caps are enabled for this offer.
        is_use_secure_link:
          type: boolean
          description: >-
            Whether tracking links use `https://` instead of `http://`. Validate
            with your account manager that SSL is enabled before using.
        is_seo_friendly:
          type: boolean
        is_allow_deep_link:
          type: boolean
          description: >-
            Whether affiliates can send their traffic to target URLs by adding
            `&url=[target URL]` to their tracking links, instead of the offer's
            destination URL.
        is_whitelist_check_enabled:
          type: boolean
          description: >-
            Whether a check is made to ensure conversion postbacks originate
            from the advertiser.
        is_use_direct_linking:
          type: boolean
          description: Whether Direct Linking is enabled for this offer.
        is_caps_enabled:
          type: boolean
          description: >-
            Whether caps are enabled. When `false`, voids all types of caps and
            custom caps.
        daily_conversion_cap:
          type: integer
          description: Maximum number of unique conversions per day.
        weekly_conversion_cap:
          type: integer
          description: Maximum conversions per week (Monday midnight to Sunday 23:59:59).
        monthly_conversion_cap:
          type: integer
          description: Maximum conversions per month.
        global_conversion_cap:
          type: integer
          description: Maximum total conversions for this offer.
        daily_payout_cap:
          type: integer
        weekly_payout_cap:
          type: integer
        monthly_payout_cap:
          type: integer
        global_payout_cap:
          type: integer
        daily_revenue_cap:
          type: integer
        weekly_revenue_cap:
          type: integer
        monthly_revenue_cap:
          type: integer
        global_revenue_cap:
          type: integer
        daily_click_cap:
          type: integer
        weekly_click_cap:
          type: integer
        monthly_click_cap:
          type: integer
        global_click_cap:
          type: integer
        is_duplicate_filter_enabled:
          type: boolean
          description: >-
            Whether duplicate clicks are filtered and acted upon, according to
            `duplicate_filter_targeting_action`.
        duplicate_filter_targeting_action:
          type: string
          enum:
            - unknown
            - block
            - fail_traffic
          description: >-
            Action to take when a duplicate click is detected. Ignored if
            `is_duplicate_filter_enabled` is `false`.
        is_block_already_converted:
          type: boolean
          description: >-
            Whether clicks from users who have already converted on this offer
            are acted upon per `already_converted_action`.
        already_converted_action:
          type: string
          enum:
            - unknown
            - block
            - fail_traffic
          description: >-
            Action to take for clicks from already-converted users. Ignored if
            `is_block_already_converted` is `false`.
        is_must_approve_conversion:
          type: boolean
          description: >-
            Whether conversions must be manually approved before being
            finalized.
        is_allow_duplicate_conversion:
          type: boolean
          description: Whether duplicate conversions are allowed.
        is_use_scrub_rate:
          type: boolean
          description: >-
            Whether a predefined percentage of conversions get automatically
            throttled (scrubbed). Only relevant if `is_must_approve_conversion`
            is `true`. This mechanism prevents an excessive number of
            conversions from being approved.
        scrub_rate_status:
          type: string
          enum:
            - rejected
            - pending
          description: >-
            Status to apply to conversions affected by throttling. Required only
            if `is_use_scrub_rate` is `true`. Can be either `rejected` or
            `pending`.
        scrub_rate_percentage:
          type: integer
          description: >-
            Percentage of conversions to automatically throttle. Only relevant
            if `is_use_scrub_rate` is `true`.
        is_view_through_enabled:
          type: boolean
          description: >-
            Whether conversions can be generated from impressions (as opposed to
            clicks only).
        view_through_destination_url:
          type: string
          description: >-
            URL of the final landing page when redirected from an impression,
            including additional macros if applicable. Only relevant if
            `is_view_through_enabled` is `true`.
        is_session_tracking_enabled:
          type: boolean
          description: >-
            Whether affiliate's conversions and payouts get automatically
            blocked based on a minimum and maximum time from the click to the
            associated conversion.
        session_tracking_lifespan_hour:
          type: integer
          description: >-
            Maximum hours between click and valid conversion. Required if
            `is_session_tracking_enabled` is `true`.
        session_tracking_minimum_lifespan_second:
          type: integer
          description: >-
            Minimum seconds between click and valid conversion. Required if
            `is_session_tracking_enabled` is `true`.
        is_fail_traffic_enabled:
          type: boolean
          description: Whether invalid clicks will be redirected to another offer.
        redirect_internal_routing_type:
          type: string
          enum:
            - priority
            - weight
            - null_value
            - priority_global
            - weight_global
          description: >
            Redirect mechanism that determines how fail traffic is distributed
            between listed offers. Can be `priority`, `weight`,
            `priority_global`, or `weight_global`. Only relevant when
            `is_fail_traffic_enabled` is `true`.
        is_using_suppression_list:
          type: boolean
          description: Whether an email suppression list is used for this offer.
        suppression_list_id:
          type: integer
          description: >-
            ID of the suppression list associated with the offer. Only relevant
            if `is_using_suppression_list` is `true`.
        is_view_through_session_tracking_enabled:
          type: boolean
          description: >-
            Whether affiliate's conversions and payouts get automatically
            blocked based on a minimum and maximum time from the impression to
            the associated conversion. Only relevant if
            `is_view_through_enabled` is `true`.
        view_through_session_tracking_lifespan_minute:
          type: integer
          description: >-
            Maximum interval of time (in minutes) between the impression event
            and a valid conversion or event. Required only if
            `is_view_through_session_tracking_enabled` is `true`.
        view_through_session_tracking_minimal_lifespan_second:
          type: integer
          description: >-
            Minimum seconds between impression and valid conversion. Only
            relevant if `is_view_through_session_tracking_enabled` is `true`.
        is_email_attribution_enabled:
          type: boolean
          description: Whether email attribution is enabled for this offer.
        email_attribution_method:
          type: string
          enum:
            - unknown
            - first_affiliate_attribution
            - last_affiliate_attribution
          description: Method used for email attribution.
        is_email_attribution_window_enabled:
          type: boolean
          description: Whether the email attribution window is enabled.
        email_attribution_window_minute:
          type: integer
          description: Duration (in minutes) of the email attribution window.
        email_attribution_window_type:
          type: string
          enum:
            - unknown
            - static
            - dynamic
          description: Type of email attribution window.
        is_using_explicit_terms_and_conditions:
          type: boolean
          description: >-
            Whether the offer uses specific Terms and Conditions. When `false`,
            defaults to the network's general Terms and Conditions.
        terms_and_conditions:
          type: string
          description: >-
            Text listing the specific Terms and Conditions of the offer.
            Required only if `is_using_explicit_terms_and_conditions` is `true`.
        is_force_terms_and_conditions:
          type: boolean
          description: >-
            Whether affiliates are required to accept the offer's specific Terms
            and Conditions.
        email:
          type: object
          description: Email compliance settings (approved subject and from lines).
          properties:
            is_enabled:
              type: boolean
              description: Whether approved subject and from lines are used.
            subject_lines:
              type: string
              description: Approved subject lines for emails.
            from_lines:
              type: string
              description: Approved from lines for emails.
        email_optout:
          type: object
          description: Email opt-out settings (suppression file and unsubscribe link).
          properties:
            is_enabled:
              type: boolean
              description: Whether the suppression file URL and unsubscribe link are used.
            suppression_file_link:
              type: string
              description: URL of the suppression file.
            unsub_link:
              type: string
              description: URL of the unsubscribe link.
        source_names:
          type: array
          items:
            type: string
          description: Pre-approved source names for this offer.
        thumbnail_file:
          type: object
          description: >
            Offer thumbnail image. Upload the file first via the Upload Temp
            File endpoint, then pass the `temp_url` and `original_file_name`
            here.
          properties:
            temp_url:
              type: string
              description: Temporary upload URL from the file upload endpoint.
            original_file_name:
              type: string
              description: Original filename of the uploaded file.
        meta:
          type: object
          description: Metadata fields for the offer.
          properties:
            advertiser_campaign_name:
              type: string
              description: Advertiser campaign name for tracking.
        channels:
          type: array
          description: Channels this offer belongs to.
          items:
            type: object
            properties:
              network_channel_id:
                type: integer
                description: Channel ID.
        integrations:
          type: object
          description: >
            Third-party integration settings. Each integration has its own
            configuration object.
          properties:
            optizmo:
              type: object
              description: Optizmo suppression list integration.
              properties:
                is_enabled:
                  type: boolean
                api_key:
                  type: string
                list_id:
                  type: string
            twentyfour_metrics:
              type: object
              description: 24Metrics fraud detection integration.
              properties:
                is_enabled:
                  type: boolean
                api_key:
                  type: string
            forensiq:
              type: object
              description: Forensiq fraud detection integration.
              properties:
                is_enabled:
                  type: boolean
                api_key:
                  type: string
            ezepo:
              type: object
              description: Ezepo integration.
              properties:
                is_enabled:
                  type: boolean
            anura:
              type: object
              description: Anura fraud detection integration.
              properties:
                is_enabled:
                  type: boolean
                instance_id:
                  type: string
            invoca:
              type: object
              description: Invoca call tracking integration.
              properties:
                is_enabled:
                  type: boolean
                campaign_id:
                  type: string
        ruleset:
          type: object
          description: >
            Targeting ruleset for this offer. Contains nested arrays for
            geographic, device, browser, and connection-type targeting. Each
            targeting entry includes an ID, `targeting_type` (`include` or
            `exclude`), and `match_type`. Sub-objects include: `platforms`,
            `device_types`, `os_versions`, `brands`, `browsers`, `languages`,
            `countries`, `regions`, `cities`, `dmas`, `mobile_carriers`, `isps`,
            `connection_types`, `ips`, `postal_codes`. Also supports day parting
            via `is_use_day_parting`, `day_parting_apply_to`,
            `day_parting_timezone_id`, and `days_parting` array.
        traffic_filters:
          type: array
          description: >
            Traffic control filters for this offer. Each filter specifies a URL
            parameter to match against.
          items:
            type: object
            properties:
              parameter:
                type: string
                description: >-
                  Parameter on which to filter traffic. Can be `sub1`, `sub2`,
                  `sub3`, `sub4`, `sub5`, `sub6`, `sub7`, `sub8`, `sub9`,
                  `sub10`, `source_id`, `user_agent`, `referer`, `idfa`,
                  `google_advertiser_id`, `http_accept_language`, or
                  `creative_id`.
                enum:
                  - sub1
                  - sub2
                  - sub3
                  - sub4
                  - sub5
                  - sub6
                  - sub7
                  - sub8
                  - sub9
                  - sub10
                  - source_id
                  - user_agent
                  - referer
                  - idfa
                  - google_advertiser_id
                  - http_accept_language
                  - creative_id
              match_type:
                type: string
                description: >-
                  Determines how the parameter values are matched. Can be
                  `exact`, `minimum`, `maximum`, `contains`, `starts_with`,
                  `range`, `ends_with`, `blank`, `does_not_match`, or
                  `does_not_contain`.
                enum:
                  - exact
                  - minimum
                  - maximum
                  - contains
                  - starts_with
                  - range
                  - ends_with
                  - blank
                  - does_not_match
                  - does_not_contain
              value:
                type: string
                description: >-
                  Value of the selected parameter to evaluate against incoming
                  traffic.
              action:
                type: string
                description: >-
                  Action to take if the incoming parameter value matches the
                  provided `value` and `match_type`. Can be either `block` or
                  `fail_traffic`.
                enum:
                  - block
                  - fail_traffic
        internal_redirects:
          type: array
          description: >
            Fail traffic redirect configuration. Determines where invalid clicks
            are sent when `is_fail_traffic_enabled` is `true`.
          items:
            type: object
            properties:
              redirect_network_offer_id:
                type: integer
                description: >-
                  ID of the offer to redirect the traffic to. One and only one
                  of `redirect_network_offer_id`,
                  `redirect_network_offer_group_id`,
                  `redirect_network_campaign_id`, or `is_pass_through` must be
                  provided.
              redirect_network_offer_url_id:
                type: integer
                description: >-
                  ID of the offer URL to redirect the traffic to. Required only
                  if `redirect_network_offer_id` is provided. Use value `0` for
                  the default offer URL.
              redirect_network_offer_group_id:
                type: integer
                description: >-
                  ID of the offer group to redirect the traffic to. One and only
                  one of `redirect_network_offer_id`,
                  `redirect_network_offer_group_id`,
                  `redirect_network_campaign_id`, or `is_pass_through` must be
                  provided.
              redirect_network_campaign_id:
                type: integer
                description: >-
                  ID of the smart link to redirect the traffic to. One and only
                  one of `redirect_network_offer_id`,
                  `redirect_network_offer_group_id`,
                  `redirect_network_campaign_id`, or `is_pass_through` must be
                  provided.
              routing_value:
                type: integer
                description: >-
                  The value used to determine priority or weight of the
                  redirect. For `priority` or `priority_global`, this is the
                  evaluation order starting with 1. For `weight` or
                  `weight_global`, this is the proportional weight relative to
                  the total of all redirects.
              is_pay_affiliate:
                type: boolean
                description: >-
                  Whether the affiliate will receive the payout if traffic is
                  sent to the redirect. Both `is_pay_affiliate` and
                  `is_pass_through` cannot be `true`.
              is_pass_through:
                type: boolean
                description: >-
                  Whether the fail traffic should be sent to the destination URL
                  of the offer. Both `is_pay_affiliate` and `is_pass_through`
                  cannot be `true`.
              categories:
                type: array
                items:
                  type: string
                  enum:
                    - traffic_filter
                    - traffic_control
                    - already_converted
                    - offer_expired
                    - geotargeting
                    - caps
                    - other
                description: >-
                  Additional requirements for a redirect to receive fail
                  traffic. The reason for the invalid traffic must match one of
                  the selected categories. Can be one or more of:
                  `traffic_filter`, `traffic_control`, `already_converted`,
                  `offer_expired`, `geotargeting`, `caps`, or `other`.
              is_apply_specific_affiliates:
                type: boolean
                description: >-
                  Whether the redirect applies for the affiliates specified by
                  `network_affiliate_ids` or for all affiliates.
              network_affiliate_ids:
                type: array
                items:
                  type: integer
                description: >-
                  IDs of the affiliates for which this redirect applies. Only
                  required if `is_apply_specific_affiliates` is `true`.
        creatives:
          type: array
          description: >
            Creatives to create alongside the offer. Each creative requires a
            name, type, and type-specific fields. This allows creating an offer
            and its creatives in a single API call.
          items:
            type: object
            properties:
              name:
                type: string
              creative_type:
                type: string
                enum:
                  - image
                  - html
                  - thumbnail
                  - email
                  - archive
                  - video
                  - text
                  - link
              is_private:
                type: boolean
              creative_status:
                type: string
                enum:
                  - active
                  - deleted
              html_code:
                type: string
              width:
                type: integer
              height:
                type: integer
              email_from:
                type: string
              email_subject:
                type: string
              resource_file:
                type: object
                description: >
                  Upload file for the creative. Only for `image`, `thumbnail`,
                  `archive`, or `video` creative types. Upload the file first
                  via the Upload Temp File endpoint, then pass the `temp_url`
                  and `original_file_name` here.
                properties:
                  temp_url:
                    type: string
                    description: Temporary URL from the file upload endpoint.
                  original_file_name:
                    type: string
                    description: Original filename of the uploaded file.
              html_files:
                type: array
                description: >
                  Files attached to the creative. Only for `html` or `email`
                  creative types. Upload each file first via the Upload Temp
                  File endpoint.
                items:
                  type: object
                  required:
                    - temp_url
                    - original_file_name
                  properties:
                    temp_url:
                      type: string
                      description: Temporary URL from the file upload endpoint.
                    original_file_name:
                      type: string
                      description: >
                        Filename used to generate the file macro (e.g. `Example
                        File Name` becomes `{{example_file_name}}`).
        requirement_kpis:
          type: array
          description: KPI requirements for this offer.
          items:
            type: object
            properties:
              kpi:
                type: string
                description: KPI description.
        requirement_tracking_parameters:
          type: array
          description: Required tracking parameters for this offer.
          items:
            type: object
            properties:
              tracking_parameter:
                type: string
                description: Parameter name.
              value:
                type: string
                description: Expected parameter value.
        payout_revenue:
          type: array
          items:
            type: object
            required:
              - entry_name
              - payout_type
              - payout_amount
              - payout_percentage
              - revenue_type
              - revenue_amount
              - revenue_percentage
              - is_default
              - is_private
              - is_postback_disabled
              - is_must_approve_conversion
              - is_allow_duplicate_conversion
            properties:
              entry_name:
                type: string
                description: Name for the base conversion. Defaults to "Base".
              payout_type:
                type: string
                enum:
                  - cpa
                  - cpc
                  - cpm
                  - cps
                  - cpa_cps
                  - prv
              payout_amount:
                type: number
                description: >-
                  Amount of the payout. Not required if `payout_type` is `cps`
                  or `prv`.
              payout_percentage:
                type: number
                description: >-
                  Percentage of the payout. Only required if `payout_type` is
                  `cps`, `cpa_cps`, or `prv`.
              revenue_type:
                type: string
                enum:
                  - rpa
                  - rpc
                  - rpm
                  - rps
                  - rpa_rps
              revenue_amount:
                type: number
                description: >-
                  Amount of the revenue. Not required if `revenue_type` is
                  `rps`.
              revenue_percentage:
                type: number
                description: >-
                  Percentage of the revenue. Only required if `revenue_type` is
                  `rps` or `rpa_rps`.
              is_default:
                type: boolean
                description: >-
                  Whether this is the default payout/revenue entry. Must be
                  `true` for the base conversion.
              is_private:
                type: boolean
                description: >-
                  Whether the payout/revenue entry is private. Must be `false`
                  for the base conversion.
              is_postback_disabled:
                type: boolean
                description: >-
                  When enabled, prevents the partner's postback from being fired
                  on a successful initial conversion. Useful when the base
                  conversion is not tied to a payable action.
              is_enforce_caps:
                type: boolean
              is_must_approve_conversion:
                type: boolean
                description: >-
                  When enabled, hides all conversions from partners and prevents
                  their postbacks from being fired. These conversions can be
                  viewed under Reporting > Conversions with status "Pending".
              is_allow_duplicate_conversion:
                type: boolean
                description: >-
                  When enabled, allows partners to deliver multiple approved
                  conversions from the same Transaction ID. If disabled,
                  duplicate conversions are rejected and not payable to
                  partners.
    Offer:
      type: object
      properties:
        network_offer_id:
          type: integer
          description: Unique offer ID.
        network_id:
          type: integer
        network_advertiser_id:
          type: integer
          description: Advertiser that owns this offer.
        network_offer_group_id:
          type: integer
          description: Offer group ID.
        name:
          type: string
          description: Offer name.
        offer_status:
          type: string
          enum:
            - active
            - paused
            - pending
            - deleted
        thumbnail_url:
          type: string
        visibility:
          type: string
          enum:
            - public
            - require_approval
            - private
        currency_id:
          type: string
        destination_url:
          type: string
          description: Destination URL for the offer.
        server_side_url:
          type: string
          description: Server-side postback URL.
        preview_url:
          type: string
        html_description:
          type: string
          description: HTML description of the offer.
        internal_notes:
          type: string
          description: Internal notes (not visible to affiliates).
        network_category_id:
          type: integer
        project_id:
          type: string
        date_live_until:
          type: string
          description: Offer expiration date (YYYY-MM-DD).
        conversion_method:
          type: string
          enum:
            - server_postback
            - http_image_pixel
            - https_image_pixel
            - http_iframe_pixel
            - https_iframe_pixel
            - javascript
            - cookie_based
            - html_pixel_cookie_based
        redirect_mode:
          type: string
          enum:
            - standard
            - single_meta_refresh
            - double_meta_refresh
            - seo_friendly
          description: >-
            Setting used to obscure referrer URLs from advertisers. Non-standard
            modes (`single_meta_refresh`, `double_meta_refresh`) are not
            recommended as they cause click drop-off.
        redirect_routing_method:
          type: string
          enum:
            - unknown
            - internal
            - null_value
        session_definition:
          type: string
          enum:
            - cookie
            - ip
            - ip_user_agent
            - google_ad_id
            - idfa
          description: Method used for determining whether a click is unique.
        session_duration:
          type: integer
          description: Session duration in hours.
        attribution_method:
          type: string
          enum:
            - first_touch
            - last_touch
        is_caps_enabled:
          type: boolean
        daily_conversion_cap:
          type: integer
        weekly_conversion_cap:
          type: integer
        monthly_conversion_cap:
          type: integer
        global_conversion_cap:
          type: integer
        daily_payout_cap:
          type: integer
        weekly_payout_cap:
          type: integer
        monthly_payout_cap:
          type: integer
        global_payout_cap:
          type: integer
        daily_revenue_cap:
          type: integer
        weekly_revenue_cap:
          type: integer
        monthly_revenue_cap:
          type: integer
        global_revenue_cap:
          type: integer
        daily_click_cap:
          type: integer
        weekly_click_cap:
          type: integer
        monthly_click_cap:
          type: integer
        global_click_cap:
          type: integer
        is_use_scrub_rate:
          type: boolean
        scrub_rate_percentage:
          type: integer
        is_duplicate_filter_enabled:
          type: boolean
        is_block_already_converted:
          type: boolean
        is_use_secure_link:
          type: boolean
        is_allow_deep_link:
          type: boolean
        is_session_tracking_enabled:
          type: boolean
        is_whitelist_check_enabled:
          type: boolean
        network_tracking_domain_id:
          type: integer
        caps_timezone_id:
          type: integer
        app_identifier:
          type: string
        labels:
          type: array
          items:
            type: string
        is_seo_friendly:
          type: boolean
        is_use_direct_linking:
          type: boolean
        is_view_through_enabled:
          type: boolean
        view_through_destination_url:
          type: string
        session_tracking_lifespan_hour:
          type: integer
        session_tracking_minimum_lifespan_second:
          type: integer
        is_fail_traffic_enabled:
          type: boolean
        redirect_internal_routing_type:
          type: string
          enum:
            - priority
            - weight
            - null_value
            - priority_global
            - weight_global
        is_using_suppression_list:
          type: boolean
        suppression_list_id:
          type: integer
        is_using_explicit_terms_and_conditions:
          type: boolean
        terms_and_conditions:
          type: string
        is_force_terms_and_conditions:
          type: boolean
        is_must_approve_conversion:
          type: boolean
        is_allow_duplicate_conversion:
          type: boolean
        duplicate_filter_targeting_action:
          type: string
          enum:
            - unknown
            - block
            - fail_traffic
        already_converted_action:
          type: string
          enum:
            - unknown
            - block
            - fail_traffic
        scrub_rate_status:
          type: string
          enum:
            - rejected
            - pending
        is_description_plain_text:
          type: boolean
        is_email_attribution_enabled:
          type: boolean
        email_attribution_method:
          type: string
          enum:
            - unknown
            - first_affiliate_attribution
            - last_affiliate_attribution
        is_email_attribution_window_enabled:
          type: boolean
        email_attribution_window_minute:
          type: integer
        email_attribution_window_type:
          type: string
          enum:
            - unknown
            - static
            - dynamic
        is_view_through_session_tracking_enabled:
          type: boolean
        view_through_session_tracking_lifespan_minute:
          type: integer
          description: Maximum minutes between impression and valid conversion.
        view_through_session_tracking_minimal_lifespan_second:
          type: integer
          description: Minimum seconds between impression and valid conversion.
        session_tracking_start_on:
          type: string
        encoded_value:
          type: string
          description: Encoded offer ID for use in tracking links.
        payout_revenue:
          type: array
          items:
            type: object
            properties:
              network_offer_payout_revenue_id:
                type: integer
                description: Unique payout/revenue configuration ID.
              entry_name:
                type: string
                description: Name for the base conversion. Defaults to "Base".
              payout_type:
                type: string
                enum:
                  - cpa
                  - cpc
                  - cpm
                  - cps
                  - cpa_cps
                  - prv
              payout_amount:
                type: number
                description: >-
                  Amount of the payout. Not required if `payout_type` is `cps`
                  or `prv`.
              payout_percentage:
                type: number
                description: >-
                  Percentage of the payout. Only required if `payout_type` is
                  `cps`, `cpa_cps`, or `prv`.
              revenue_type:
                type: string
                enum:
                  - rpa
                  - rpc
                  - rpm
                  - rps
                  - rpa_rps
              revenue_amount:
                type: number
                description: >-
                  Amount of the revenue. Not required if `revenue_type` is
                  `rps`.
              revenue_percentage:
                type: number
                description: >-
                  Percentage of the revenue. Only required if `revenue_type` is
                  `rps` or `rpa_rps`.
              is_default:
                type: boolean
                description: >-
                  Whether this is the default payout/revenue entry. Must be
                  `true` for the base conversion.
              is_private:
                type: boolean
                description: >-
                  Whether the payout/revenue entry is private. Must be `false`
                  for the base conversion.
              is_postback_disabled:
                type: boolean
                description: >-
                  When enabled, prevents the partner's postback from being fired
                  on a successful initial conversion. Useful when the base
                  conversion is not tied to a payable action.
              is_enforce_caps:
                type: boolean
              is_must_approve_conversion:
                type: boolean
                description: >-
                  When enabled, hides all conversions from partners and prevents
                  their postbacks from being fired. These conversions can be
                  viewed under Reporting > Conversions with status "Pending".
              is_allow_duplicate_conversion:
                type: boolean
                description: >-
                  When enabled, allows partners to deliver multiple approved
                  conversions from the same Transaction ID. If disabled,
                  duplicate conversions are rejected and not payable to
                  partners.
              is_email_attribution_default_event:
                type: boolean
              remote_offer_resource:
                type: object
                description: Remote offer resource linked to this payout/revenue entry.
                properties:
                  network_offer_id:
                    type: integer
                  network_id:
                    type: integer
                  resource_type:
                    type: string
                  remote_resource_id:
                    type: string
                  resource_id:
                    type: integer
                  last_value_md5:
                    type: string
                  json_config:
                    type: string
                  json_data:
                    type: string
                  time_created:
                    type: integer
                    example: 1734455015
                  time_saved:
                    type: integer
                    example: 1734455015
        is_soft_cap:
          type: boolean
          description: Whether soft caps are enabled for this offer.
        time_created:
          type: integer
          example: 1734455015
          description: Unix timestamp of creation.
        time_saved:
          type: integer
          example: 1734455015
          description: Unix timestamp of last update.
        relationship:
          type: object
          description: Related data returned with the offer.
          properties:
            advertiser:
              type: object
              description: Advertiser that owns this offer.
              properties:
                network_advertiser_id:
                  type: integer
                network_id:
                  type: integer
                name:
                  type: string
                account_status:
                  type: string
                network_employee_id:
                  type: integer
                internal_notes:
                  type: string
                address_id:
                  type: integer
                is_contact_address_enabled:
                  type: boolean
                sales_manager_id:
                  type: integer
                is_expose_publisher_reporting_data:
                  type: boolean
                  nullable: true
                default_currency_id:
                  type: string
                platform_name:
                  type: string
                platform_url:
                  type: string
                platform_username:
                  type: string
                reporting_timezone_id:
                  type: integer
                accounting_contact_email:
                  type: string
                verification_token:
                  type: string
                offer_id_macro:
                  type: string
                affiliate_id_macro:
                  type: string
                time_created:
                  type: integer
                  example: 1734455015
                time_saved:
                  type: integer
                  example: 1734455015
                attribution_method:
                  type: string
                email_attribution_method:
                  type: string
                attribution_priority:
                  type: string
            category:
              type: object
              description: Offer category.
              properties:
                network_category_id:
                  type: integer
                network_id:
                  type: integer
                name:
                  type: string
                status:
                  type: string
                time_created:
                  type: integer
                  example: 1734455015
                time_saved:
                  type: integer
                  example: 1734455015
            creatives:
              type: object
              description: Creatives associated with this offer.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
            traffic_filters:
              type: object
              description: Traffic filters configured for this offer.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
            labels:
              type: object
              description: Labels applied to this offer.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
            payout_revenue:
              type: object
              description: Payout and revenue configurations.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
                    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
                      payout_percentage:
                        type: number
                      revenue_type:
                        type: string
                      revenue_amount:
                        type: number
                      revenue_percentage:
                        type: number
                      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 linked to this payout/revenue
                          entry.
                        properties:
                          network_offer_id:
                            type: integer
                          network_id:
                            type: integer
                          resource_type:
                            type: string
                          remote_resource_id:
                            type: string
                          resource_id:
                            type: integer
                          last_value_md5:
                            type: string
                          json_config:
                            type: string
                          json_data:
                            type: string
                          time_created:
                            type: integer
                            example: 1734455015
                          time_saved:
                            type: integer
                            example: 1734455015
            custom_cap_settings:
              type: object
              description: Custom cap settings per affiliate.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
            custom_scrub_rate_settings:
              type: object
              description: Custom scrub rate settings per affiliate.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
            custom_payout_revenue_settings:
              type: object
              description: Custom payout/revenue settings per affiliate.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
            reporting:
              type: object
              description: Aggregated reporting metrics for this offer.
              properties:
                imp:
                  type: integer
                total_click:
                  type: integer
                unique_click:
                  type: integer
                invalid_click:
                  type: integer
                duplicate_click:
                  type: integer
                gross_click:
                  type: integer
                ctr:
                  type: number
                cv:
                  type: integer
                invalid_cv_scrub:
                  type: integer
                view_through_cv:
                  type: integer
                total_cv:
                  type: integer
                event:
                  type: integer
                cvr:
                  type: number
                evr:
                  type: number
                cpc:
                  type: number
                cpm:
                  type: number
                cpa:
                  type: number
                epc:
                  type: number
                rpc:
                  type: number
                rpa:
                  type: number
                rpm:
                  type: number
                payout:
                  type: number
                revenue:
                  type: number
                event_revenue:
                  type: number
                gross_sales:
                  type: number
                profit:
                  type: number
                margin:
                  type: number
                roas:
                  type: number
                avg_sale_value:
                  type: number
                media_buying_cost:
                  type: number
                on_hold_potential_revenue:
                  type: number
                on_hold_potential_payout:
                  type: number
                on_hold_conversion_count:
                  type: integer
                public_events:
                  type: integer
            audits:
              type: object
              description: Audit log entries for this offer.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
            visibility:
              type: object
              description: >-
                Visibility settings controlling which affiliates can see or are
                blocked from the offer.
              properties:
                network_id:
                  type: integer
                network_offer_id:
                  type: integer
                network_affiliate_visible_ids:
                  type: array
                  items:
                    type: integer
                network_affiliate_rejected_ids:
                  type: array
                  items:
                    type: integer
                network_affiliate_hidden_ids:
                  type: array
                  items:
                    type: integer
            integrations:
              type: object
              description: Third-party integration settings.
              properties:
                optizmo:
                  type: object
                  nullable: true
                twentyfour_metrics:
                  type: object
                  nullable: true
                offer_demand_partner:
                  type: object
                  nullable: true
                forensiq:
                  type: object
                  nullable: true
                ezepo:
                  type: object
                  nullable: true
                anura:
                  type: object
                  nullable: true
                invoca:
                  type: object
                  nullable: true
                ip_quality_score:
                  type: object
                  nullable: true
                unsubcentral:
                  type: object
                  nullable: true
                ringba:
                  type: object
                  nullable: true
                retreaver:
                  type: object
                  nullable: true
            ruleset:
              type: object
              description: Targeting ruleset for this offer.
              properties:
                network_id:
                  type: integer
                network_ruleset_id:
                  type: integer
                time_created:
                  type: integer
                  example: 1734455015
                time_saved:
                  type: integer
                  example: 1734455015
                platforms:
                  type: array
                  items:
                    type: object
                device_types:
                  type: array
                  items:
                    type: object
                os_versions:
                  type: array
                  items:
                    type: object
                browsers:
                  type: array
                  items:
                    type: object
                languages:
                  type: array
                  items:
                    type: object
                countries:
                  type: array
                  items:
                    type: object
                regions:
                  type: array
                  items:
                    type: object
                cities:
                  type: array
                  items:
                    type: object
                dmas:
                  type: array
                  items:
                    type: object
                mobile_carriers:
                  type: array
                  items:
                    type: object
                connection_types:
                  type: array
                  items:
                    type: object
                ips:
                  type: array
                  items:
                    type: object
                is_block_proxy:
                  type: boolean
                is_use_day_parting:
                  type: boolean
                day_parting_apply_to:
                  type: string
                day_parting_timezone_id:
                  type: integer
                days_parting:
                  type: array
                  items:
                    type: object
                isps:
                  type: array
                  items:
                    type: object
                brands:
                  type: array
                  items:
                    type: object
                postal_codes:
                  type: array
                  items:
                    type: object
            source_names:
              type: object
              description: Pre-approved source names for this offer.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
            urls:
              type: object
              description: Additional offer URLs.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
            encoded_value:
              type: string
              description: Encoded offer ID for use in tracking links.
            remaining_caps:
              type: object
              description: Remaining cap values for the offer across all cap types.
              properties:
                remaining_daily_payout_cap:
                  type: number
                remaining_daily_revenue_cap:
                  type: number
                remaining_daily_conversion_cap:
                  type: number
                remaining_daily_click_cap:
                  type: number
                remaining_weekly_payout_cap:
                  type: number
                remaining_weekly_revenue_cap:
                  type: number
                remaining_weekly_conversion_cap:
                  type: number
                remaining_weekly_click_cap:
                  type: number
                remaining_monthly_payout_cap:
                  type: number
                remaining_monthly_revenue_cap:
                  type: number
                remaining_monthly_conversion_cap:
                  type: number
                remaining_monthly_click_cap:
                  type: number
                remaining_global_payout_cap:
                  type: number
                remaining_global_revenue_cap:
                  type: number
                remaining_global_conversion_cap:
                  type: number
                remaining_global_click_cap:
                  type: number
            is_locked_currency:
              type: boolean
              description: Whether the currency is locked for this offer.
            custom_creative_settings:
              type: object
              description: Custom creative settings per affiliate.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
            channels:
              type: object
              description: Channels this offer belongs to.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
            is_locked_caps_timezone:
              type: boolean
              description: Whether the caps timezone is locked for this offer.
            meta:
              type: object
              description: App metadata for this offer.
              properties:
                network_offer_id:
                  type: integer
                network_id:
                  type: integer
                app_id:
                  type: string
                meta_platform:
                  type: string
                advertiser_campaign_name:
                  type: string
                bundle_id:
                  type: string
                category:
                  type: string
                store_url:
                  type: string
                score_rating:
                  type: number
                total_rating:
                  type: number
                size:
                  type: number
                developer:
                  type: string
                version:
                  type: string
                is_app_unavailable:
                  type: boolean
                time_created:
                  type: integer
                  example: 1734455015
                time_app_data_saved:
                  type: integer
                  example: 1734455015
                time_saved:
                  type: integer
                  example: 1734455015
            requirement_kpis:
              type: object
              description: KPI requirements for this offer.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
            requirement_tracking_parameters:
              type: object
              description: Required tracking parameters for this offer.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: object
  securitySchemes:
    API Key:
      description: The Everflow API key generated from the Control Center > Security.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey

````