openapi: 3.2.0
info:
  title: Magnite Deal Lists API
  version: '1.0'
  description: 'Operations tagged Deal Lists across 2 of this provider''s published API definitions: magnite-springserve-v0-openapi.yml, magnite-springserve-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://console.springserve.com
  description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
- url: https://api.springserve.com
  description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
security:
- api_key: []
- bearer_token: []
tags:
- name: Deal Lists
paths:
  /api/v0/deal_lists:
    get:
      summary: Index
      description: Retrieve a list of all deal lists. Available for ClearLine account types.
      parameters:
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: List of deal lists
          content:
            application/json:
              schema:
                $ref: ref/schemas.yaml#/components/schemas/ListResponse
      tags:
      - Deal Lists
      operationId: deal_lists_get
    post:
      summary: Create
      description: Create a deal list with optional deals. Available for ClearLine account types.
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              simple:
                $ref: '#/components/examples/deal_list_create_simple'
              full:
                $ref: '#/components/examples/deal_list_create_full'
        required: true
      responses:
        '201':
          description: Created deal list
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v0/deal_lists/{id}:
    get:
      summary: Show
      description: Show details for a specific deal list
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deal list details
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_id_get
    put:
      summary: Update
      description: Update a deal list (name, description, status)
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              simple:
                $ref: '#/components/examples/deal_list_update_simple'
              full:
                $ref: '#/components/examples/deal_list_update_full'
      responses:
        '200':
          description: Updated deal list
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_id_put
    delete:
      summary: Destroy
      description: Permanently delete a deal list. This action cannot be undone.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
      tags:
      - Deal Lists
      operationId: deal_lists_id_delete
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v0/deal_lists/{id}/deals:
    get:
      summary: List deals
      description: Retrieve all deals in a deal list
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: List of deals in the deal list
          content:
            application/json:
              schema:
                $ref: ref/schemas.yaml#/components/schemas/ListResponse
      tags:
      - Deal Lists
      operationId: deal_lists_id_deals_get
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v0/deal_lists/{id}/deals/bulk_create:
    post:
      summary: Bulk create deals
      description: Add deals to a deal list
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              single:
                $ref: '#/components/examples/deal_list_deals_bulk_create_single'
              multiple:
                $ref: '#/components/examples/deal_list_deals_bulk_create_multiple'
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_id_deals_bulk_create_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v0/deal_lists/{id}/deals/bulk_delete:
    delete:
      summary: Bulk delete deals
      description: Remove deals from a deal list
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_id_deals_bulk_delete_delete
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v0/deal_lists/{id}/deals/bulk_replace:
    post:
      summary: Bulk replace deals
      description: Replace all deals in a deal list
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              single:
                $ref: '#/components/examples/deal_list_deals_bulk_replace_single'
              multiple:
                $ref: '#/components/examples/deal_list_deals_bulk_replace_multiple'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_id_deals_bulk_replace_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/deal_lists:
    get:
      summary: Index
      parameters:
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/sortParam
      - $ref: ref/params.yaml#/components/parameters/searchParam
      - $ref: ref/params.yaml#/components/parameters/filterParams
      - name: deal_id
        in: query
        description: Filter deal lists that contain the specified deal ID
        schema:
          type: integer
      - $ref: ref/params.yaml#/components/parameters/includeParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_get
    post:
      summary: Create
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              simple:
                $ref: '#/components/examples/deal_list_create_simple'
              full:
                $ref: '#/components/examples/deal_list_create_full'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/deal_lists/{deal_list_id}:
    get:
      summary: Show
      parameters:
      - name: deal_list_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_deal_list_id_get
    patch:
      summary: Update
      parameters:
      - name: deal_list_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              simple:
                $ref: '#/components/examples/deal_list_update_simple'
              full:
                $ref: '#/components/examples/deal_list_update_full'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_deal_list_id_patch
    delete:
      summary: Delete
      parameters:
      - name: deal_list_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
        '422':
          $ref: ref/errors.yaml#/components/responses/validationError
      tags:
      - Deal Lists
      operationId: deal_lists_deal_list_id_delete
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/deal_lists/bulk_update:
    post:
      summary: Bulk Update
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              single:
                $ref: '#/components/examples/deal_list_bulk_update_single'
              multiple:
                $ref: '#/components/examples/deal_list_bulk_update_multiple'
        required: true
      responses:
        '200':
          description: Bulk update completed
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Status message describing the bulk update results
                examples:
                - message: 'Successfully updated 2 Deal Lists: 2, 3'
      tags:
      - Deal Lists
      operationId: deal_lists_bulk_update_same_attributes_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/deal_lists/permissions:
    get:
      summary: Permissions Collection
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_permissions_get
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/deal_lists/{deal_list_id}/deals:
    get:
      summary: Deals
      parameters:
      - name: deal_list_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_deal_list_id_deals_get
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/deal_lists/{id}/permissions:
    get:
      summary: Permissions Member
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_id_permissions_get
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/deal_lists/{deal_list_id}/deals/bulk_create:
    post:
      summary: Add Deals
      parameters:
      - name: deal_list_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              single:
                $ref: '#/components/examples/deal_list_deals_bulk_create_single'
              multiple:
                $ref: '#/components/examples/deal_list_deals_bulk_create_multiple'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_deal_list_id_deals_bulk_create_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/deal_lists/{deal_list_id}/deals/bulk_delete:
    delete:
      summary: Delete Deals
      parameters:
      - name: deal_list_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              deals:
              - 1
              - 2
            schema:
              type: object
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_deal_list_id_deals_bulk_delete_delete
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/deal_lists/{deal_list_id}/deals/bulk_replace:
    post:
      summary: Replace Deals
      parameters:
      - name: deal_list_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              single:
                $ref: '#/components/examples/deal_list_deals_bulk_replace_single'
              multiple:
                $ref: '#/components/examples/deal_list_deals_bulk_replace_multiple'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Deal Lists
      operationId: deal_lists_deal_list_id_deals_bulk_replace_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
components:
  examples:
    deal_list_deals_bulk_replace_multiple:
      summary: Multiple
      value:
        deals:
        - 1
        - 2
        - 3
    deal_list_create_simple:
      summary: Simple
      value:
        name: Deal List Name
    deal_list_create_full:
      summary: Full
      value:
        name: Deal List Name
        description: Deal list description
        is_active: true
        deals:
        - 1
    deal_list_deals_bulk_create_single:
      summary: Single
      value:
        deals:
        - 1
    deal_list_update_full:
      summary: Full
      value:
        name: Deal List Name
        description: Deal list description
        is_active: true
        deals:
        - 1
    deal_list_update_simple:
      summary: Simple
      value:
        name: Deal List Name
    deal_list_deals_bulk_replace_single:
      summary: Single
      value:
        deals:
        - 1
    deal_list_deals_bulk_create_multiple:
      summary: Multiple
      value:
        deals:
        - 1
        - 2
        - 3
    deal_list_bulk_update_single:
      summary: Single
      value:
        is_active: true
        object_ids:
        - 1
    deal_list_bulk_update_multiple:
      summary: Multiple
      value:
        is_active: true
        object_ids:
        - 1
        - 2
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: SpringServe authorization token based authentication.
    bearer_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: SpringServe authorization bearer token based authentication.  This key is included in the response from the /api/v0/auth and /api/v1/auth endpoints.  This key will be automatically set if you run the example for /api/v0/auth or /api/v1/auth
x-refined-from:
- magnite-springserve-v0-openapi.yml
- magnite-springserve-v1-openapi.yml