openapi: 3.2.0
info:
  title: SpringServe UI API (V0) Operative API
  version: 0.1.0
  description: "> **_NOTE:_** This document covers the v0 API (`/api/v0`). You can find additional documentation on the v0 API (`/api/v0`) on the \n[Magnite Help Center](https://help.magnite.com/), which is broken into sections for endpoints relevant to \n[SpringServe](https://help.magnite.com/help/api-documentation) and [Clearline](https://help.magnite.com/help/api-documentation-06dd4d3). \nYou can also find V1 swagger documentation by selecting ‘SpringServe API V1’ from the dropdown at the top right corner \nof this page. Please note we are in the process of creating V1 endpoints for all existing V0 endpoints, but while that work \nis in progress not all endpoints will be supported on V1. We advise reviewing both swagger pages to determine what \nis supported in each version.\n\n# Authentication\nWhen using this API documentation server, by default it will authenticate API calls using cookie-based authentication agains the selected server.  If you are properly logged into the SpringServe server and your session is still active, then the API calls should automatically authenticate.  \n\nOutside of this API documentation server you should use either Token Based or Bearer authentication.  You may also these authentication methods on this server as well,\n which will take precedence over any cookie/session based authentication.\n### Token Based Authentication\nUse the [POST /api/v0/auth](#/Auth/auth_post) endpoint to generate an API token that is then passed in the `Authorization: <token>` header\n\n### Bearer Authentication\nUse the [POST /api/v0/auth](#/Auth/auth_post) endpoint to authenticate and get a bearer token that is then passed in the `Authorization: Bearer <token>` header\n\n# Active Account Context\nA given request always runs in the context of currently active account for the authenticated user making\nthe request. The active account can be determined via the [GET /api/v0/accounts/current](#/Accounts/accounts_current_get)\nendpoint and updated via [POST /api/v0/accounts/{id}/set_current](#/Accounts/accounts_id_set_current_post).\nThe active account can also be overridden for an authenticated request by passing the `x-auth-context` header.\n\n# V0 List Resource Functionality\nV0 list endpoints support pagination via the `page` (first page is page 1) and `per` (how many results\nper page) query parameters. Some endpoints also support filtering by `ids[]` (repeated query param, e.g. ids[]=1&ids[]=2).\n"
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: Operative
paths:
  /api/v0/operative/advertisers:
    post:
      summary: Create Operative Advertiser
      description: Create an advertiser in Operative integration
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              operative_advertiser_create_simple:
                $ref: '#/components/examples/operative_advertiser_create_simple'
              operative_advertiser_create_full:
                $ref: '#/components/examples/operative_advertiser_create_full'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Operative
      operationId: operative_advertisers_post
  /api/v0/operative/orders:
    post:
      summary: Create Operative Order
      description: Create an order in Operative integration
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              operative_order_create_simple:
                $ref: '#/components/examples/operative_order_create_simple'
              operative_order_create_full:
                $ref: '#/components/examples/operative_order_create_full'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Operative
      operationId: operative_orders_post
    put:
      summary: Update Operative Order
      description: Update an order in Operative integration
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              operative_order_update_simple:
                $ref: '#/components/examples/operative_order_update_simple'
              operative_order_update_full:
                $ref: '#/components/examples/operative_order_update_full'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Operative
      operationId: operative_orders_put
components:
  examples:
    operative_order_create_simple:
      summary: Simple
      value:
        sourceOrderId: '1'
        name: Operative Order Name
        advertiserId: '1'
    operative_order_update_simple:
      summary: Simple
      value:
        orderId: '1'
        lineitems:
        - lineitemId: '1'
          name: Operative Line Item Name
    operative_advertiser_create_simple:
      summary: Simple
      value:
        sourceAdvertiserId: '1'
        name: Operative Advertiser Name
    operative_order_create_full:
      summary: Full
      value:
        sourceOrderId: '1'
        name: Operative Order Name
        advertiserId: '1'
        startDate: '2026-01-01'
        endDate: '2026-12-31'
        lineitems:
        - lineitemId: '1'
          sourceLineitemId: '1'
          name: Operative Line Item Name
          quantity: 1
          costType: CPM
          unitCost: 1.11
          timeZone: America/New_York
          startDate: '2026-01-01'
          endDate: '2026-12-31'
          targets:
          - targetName: geo
            targetValues:
            - US
    operative_advertiser_create_full:
      summary: Full
      value:
        sourceAdvertiserId: '1'
        name: Operative Advertiser Name
    operative_order_update_full:
      summary: Full
      value:
        orderId: '1'
        lineitems:
        - lineitemId: '1'
          sourceLineitemId: '1'
          name: Operative Line Item Name
          quantity: 1
          costType: CPM
          unitCost: 1.11
          timeZone: America/New_York
          startDate: '2026-01-01'
          endDate: '2026-12-31'
          targets:
          - targetName: geo
            targetValues:
            - US
  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