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

Create a new offer group. Optionally configure labels, internal notes, and caps (conversion, payout, revenue, and click caps at daily, weekly, monthly, and global levels).


## OpenAPI

````yaml openapi/offer-groups.yaml post /networks/offergroups
openapi: 3.0.3
info:
  title: Everflow Network API - Offer Groups
  description: >
    Endpoints for managing offer groups in the Everflow network. Offer groups
    let you centrally manage and track multiple campaigns by setting shared
    budget caps across related offers. For setup, see the [Offer Groups
    guide](https://helpdesk.everflow.io/customer/how-to-create-offer-groups).
  version: 1.0.0
servers:
  - url: https://api.eflow.team/v1
security: []
tags:
  - name: Offer Groups
paths:
  /networks/offergroups:
    post:
      tags:
        - Offer Groups
      summary: Create Offer Group
      requestBody:
        required: true
        content:
          application/json:
            examples:
              minimal:
                summary: Minimal (no caps)
                value:
                  name: Holiday Offers
                  offer_group_status: active
                  network_advertiser_id: 13
                  network_offer_ids:
                    - 1
                  currency_id: USD
              with_caps:
                summary: With caps enabled
                value:
                  name: Holiday Offers
                  offer_group_status: active
                  network_advertiser_id: 13
                  network_offer_ids:
                    - 1
                    - 8
                  currency_id: USD
                  labels:
                    - holiday
                  internal_notes: Q4 campaign group
                  is_caps_enabled: true
                  is_soft_cap: false
                  weekly_click_cap: 1000
                  daily_conversion_cap: 50
                  monthly_payout_cap: 5000
            schema:
              $ref: '#/components/schemas/OfferGroupInput'
      responses:
        '200':
          description: ''
          content:
            application/json:
              example:
                network_offer_group_id: 6
                network_id: 1
                network_advertiser_id: 13
                name: Holiday Offers
                internal_notes: ''
                offer_group_status: active
                is_caps_enabled: true
                daily_conversion_cap: 0
                weekly_conversion_cap: 0
                monthly_conversion_cap: 0
                global_conversion_cap: 0
                daily_payout_cap: 0
                weekly_payout_cap: 0
                monthly_payout_cap: 0
                global_payout_cap: 0
                daily_revenue_cap: 0
                weekly_revenue_cap: 0
                monthly_revenue_cap: 0
                global_revenue_cap: 0
                daily_click_cap: 0
                weekly_click_cap: 1
                monthly_click_cap: 0
                global_click_cap: 0
                time_created: 1774725628
                time_saved: 1774725628
                relationship:
                  advertiser:
                    network_advertiser_id: 13
                    network_id: 1
                    name: William Fowler Inc.
                    account_status: active
                  labels:
                    total: 0
                    entries: []
                  network_offer_ids:
                    - 1
                  remaining_caps:
                    remaining_daily_payout_cap: -1000
                    remaining_daily_revenue_cap: -1000
                    remaining_daily_conversion_cap: -1000
                    remaining_daily_click_cap: -1000
                    remaining_weekly_payout_cap: -1000
                    remaining_weekly_revenue_cap: -1000
                    remaining_weekly_conversion_cap: -1000
                    remaining_weekly_click_cap: 1
                    remaining_monthly_payout_cap: -1000
                    remaining_monthly_revenue_cap: -1000
                    remaining_monthly_conversion_cap: -1000
                    remaining_monthly_click_cap: -1000
                    remaining_global_payout_cap: -1000
                    remaining_global_revenue_cap: -1000
                    remaining_global_conversion_cap: -1000
                    remaining_global_click_cap: -1000
                is_soft_cap: false
              schema:
                $ref: '#/components/schemas/OfferGroup'
      security:
        - API Key: []
components:
  schemas:
    OfferGroupInput:
      type: object
      required:
        - name
        - offer_group_status
        - network_advertiser_id
        - network_offer_ids
        - currency_id
      properties:
        name:
          type: string
          description: Name of the offer group.
        offer_group_status:
          type: string
          enum:
            - active
            - paused
            - deleted
          description: Status of the offer group.
        network_advertiser_id:
          type: integer
          description: ID of the advertiser for the offer group.
        network_offer_ids:
          type: array
          items:
            type: integer
          description: >-
            IDs of the offers to include in the offer group. The offers must
            belong to the specified advertiser.
        currency_id:
          type: string
          description: >
            Currency for the offer group. See the [List
            Currencies](/api-reference/get-metacurrencies) endpoint for
            available values.
        labels:
          type: array
          items:
            type: string
          description: Labels to assign to this offer group.
        internal_notes:
          type: string
          description: Internal notes about the offer group.
        is_caps_enabled:
          type: boolean
          description: Whether caps are enabled. When false, all cap values are ignored.
        is_soft_cap:
          type: boolean
          description: >
            When true, caps are soft (tracking continues but a notification is
            sent). When false, caps are hard (tracking stops when the cap is
            reached).
        daily_conversion_cap:
          type: integer
          description: Limit to the number of unique conversions in one day.
        weekly_conversion_cap:
          type: integer
          description: >-
            Limit to the number of unique conversions in one week (Monday
            midnight to Sunday 23h59:59).
        monthly_conversion_cap:
          type: integer
          description: Limit to the number of unique conversions in one month.
        global_conversion_cap:
          type: integer
          description: Limit to the total number of unique conversions at the offer level.
        daily_payout_cap:
          type: number
          description: Limit to the affiliate's payout for one day.
        weekly_payout_cap:
          type: number
          description: >-
            Limit to the affiliate's payout for a week (Monday midnight to
            Sunday 23h59:59).
        monthly_payout_cap:
          type: number
          description: Limit to the affiliate's payout for one month.
        global_payout_cap:
          type: number
          description: Limit to the affiliate's total payout at the offer level.
        daily_revenue_cap:
          type: number
          description: Limit to the network's revenue for one day.
        weekly_revenue_cap:
          type: number
          description: >-
            Limit to the network's revenue for a week (Monday midnight to Sunday
            23h59:59).
        monthly_revenue_cap:
          type: number
          description: Limit to the network's revenue for one month.
        global_revenue_cap:
          type: number
          description: Limit to the network's total revenue at the offer level.
        daily_click_cap:
          type: integer
          description: Limit to the number of unique clicks in one day.
        weekly_click_cap:
          type: integer
          description: >-
            Limit to the number of unique clicks in a week (Monday midnight to
            Sunday 23h59:59).
        monthly_click_cap:
          type: integer
          description: Limit to the number of unique clicks in one month.
        global_click_cap:
          type: integer
          description: Limit to the total number of unique clicks at the offer level.
    OfferGroup:
      type: object
      properties:
        network_offer_group_id:
          type: integer
          description: Unique offer group ID.
        network_id:
          type: integer
          description: Network ID.
        network_advertiser_id:
          type: integer
          description: ID of the advertiser for the offer group.
        name:
          type: string
          description: Name of the offer group.
        internal_notes:
          type: string
          description: Internal notes about the offer group.
        offer_group_status:
          type: string
          enum:
            - active
            - paused
            - deleted
          description: >-
            Status of the offer group. Can be one of the following values:
            `active`, `paused` or `deleted`.
        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: Limit to the number of unique conversions in one day.
        weekly_conversion_cap:
          type: integer
          description: >-
            Limit to the number of unique conversions in one week (Monday
            midnight to Sunday 23h59:59).
        monthly_conversion_cap:
          type: integer
          description: Limit to the number of unique conversions in one month.
        global_conversion_cap:
          type: integer
          description: Limit to the total number of unique conversions at the offer level.
        daily_payout_cap:
          type: number
          description: Limit to the affiliate's payout for one day.
        weekly_payout_cap:
          type: number
          description: >-
            Limit to the affiliate's payout for a week (Monday midnight to
            Sunday 23h59:59).
        monthly_payout_cap:
          type: number
          description: Limit to the affiliate's payout for one month.
        global_payout_cap:
          type: number
          description: Limit to the affiliate's total payout at the offer level.
        daily_revenue_cap:
          type: number
          description: Limit to the network's revenue for one day.
        weekly_revenue_cap:
          type: number
          description: >-
            Limit to the network's revenue for a week (Monday midnight to Sunday
            23h59:59).
        monthly_revenue_cap:
          type: number
          description: Limit to the network's revenue for one month.
        global_revenue_cap:
          type: number
          description: Limit to the network's total revenue at the offer level.
        daily_click_cap:
          type: integer
          description: Limit to the number of unique clicks in one day.
        weekly_click_cap:
          type: integer
          description: >-
            Limit to the number of unique clicks in a week (Monday midnight to
            Sunday 23h59:59).
        monthly_click_cap:
          type: integer
          description: Limit to the number of unique clicks in one month.
        global_click_cap:
          type: integer
          description: Limit to the total number of unique clicks at the offer level.
        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
          properties:
            advertiser:
              type: object
              description: Associated advertiser details.
              properties:
                network_advertiser_id:
                  type: integer
                network_id:
                  type: integer
                name:
                  type: string
                account_status:
                  type: string
                network_employee_id:
                  type: integer
                  description: Account manager employee ID.
                sales_manager_id:
                  type: integer
                  description: Sales manager ID.
                address_id:
                  type: integer
                  description: Address ID.
                is_contact_address_enabled:
                  type: boolean
                  description: Whether contact address is enabled.
                default_currency_id:
                  type: string
                  description: Default currency.
                platform_name:
                  type: string
                  description: Platform name.
                platform_url:
                  type: string
                  description: Platform URL.
                platform_username:
                  type: string
                  description: Platform username.
                offer_id_macro:
                  type: string
                  description: Offer ID macro.
                affiliate_id_macro:
                  type: string
                  description: Affiliate ID macro.
                accounting_contact_email:
                  type: string
                  description: Accounting contact email.
                internal_notes:
                  type: string
                  description: Internal notes.
                attribution_method:
                  type: string
                  description: Attribution method.
                email_attribution_method:
                  type: string
                  description: Email attribution method.
                attribution_priority:
                  type: string
                  description: Attribution priority.
                verification_token:
                  type: string
                  description: Verification token.
                is_expose_publisher_reporting_data:
                  type: boolean
                  description: Whether to expose publisher reporting data.
                reporting_timezone_id:
                  type: string
                  description: Reporting timezone ID.
                time_created:
                  type: integer
                  example: 1734455015
                  description: Unix timestamp of advertiser creation.
                time_saved:
                  type: integer
                  example: 1734455015
                  description: Unix timestamp of advertiser last update.
            labels:
              type: object
              description: Labels assigned to this offer group.
              properties:
                total:
                  type: integer
                entries:
                  type: array
                  items:
                    type: string
            network_offer_ids:
              type: array
              items:
                type: integer
              description: IDs of the offers included in the offer group.
            remaining_caps:
              type: object
              description: >
                Remaining cap values for each cap type. A value of -1000
                indicates the cap is not set (unlimited).
              properties:
                remaining_daily_payout_cap:
                  type: number
                remaining_daily_revenue_cap:
                  type: number
                remaining_daily_conversion_cap:
                  type: integer
                remaining_daily_click_cap:
                  type: integer
                remaining_weekly_payout_cap:
                  type: number
                remaining_weekly_revenue_cap:
                  type: number
                remaining_weekly_conversion_cap:
                  type: integer
                remaining_weekly_click_cap:
                  type: integer
                remaining_monthly_payout_cap:
                  type: number
                remaining_monthly_revenue_cap:
                  type: number
                remaining_monthly_conversion_cap:
                  type: integer
                remaining_monthly_click_cap:
                  type: integer
                remaining_global_payout_cap:
                  type: number
                remaining_global_revenue_cap:
                  type: number
                remaining_global_conversion_cap:
                  type: integer
                remaining_global_click_cap:
                  type: integer
        is_soft_cap:
          type: boolean
          description: Whether soft caps are enabled for this offer group.
  securitySchemes:
    API Key:
      description: The Everflow API key generated from the Control Center > Security.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey

````