--- servers: - url: https://console.springserve.com/api/v0 description: >- SpringServe console. Added by API Evangelist from the published documentation (springserve.atlassian.net/wiki/spaces/SSD/pages/1573617663/API+-+Getting+Started, "Base Url https://console.springserve.com/"); the document Magnite serves declares no servers[] block because the Swagger UI infers the host from window.location. - url: https://console.clearline.magnite.com/api/v0 description: >- ClearLine console. The identical contract is served from ClearLine's own host; base URL published at springserve.atlassian.net/wiki/spaces/CLD/pages/3649929217/Clearline+API+SDK. x-servers-added-by: https://apievangelist.com — not present in the upstream document; see openapi/_original/ for the verbatim spec. openapi: 3.1.2 info: title: SpringServe UI API (V0) 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: ` 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 ` 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" paths: "/api/v0/accounts": get: summary: Index description: List all Accounts accessible to the current user 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Accounts operationId: accounts_get "/api/v0/advertiser_domain_lists": get: summary: Index description: List all advertiser domain lists. Supports pagination via page, per, and ids params. 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 advertiser domain lists content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Advertiser Domain Lists operationId: advertiser_domain_lists_get post: summary: Create description: Creating an advertiser domain list requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/advertiser_domain_list_create_simple" full: "$ref": "#/components/examples/advertiser_domain_list_create_full" required: true responses: '201': description: Created advertiser domain list content: application/json: schema: type: object example: description: My description id: 123 name: My Test Advertiser Domain List account_id: 1 tags: - Advertiser Domain Lists operationId: advertiser_domain_lists_post "/api/v0/app_bundle_lists": get: summary: Index description: List all app bundle lists. Supports pagination via page, per, and ids params. 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 app bundle lists content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - App Bundle Lists operationId: app_bundle_lists_get post: summary: Create description: Creating an App Bundle List requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/app_bundle_list_create_simple" full: "$ref": "#/components/examples/app_bundle_list_create_full" required: true responses: '201': description: Created app bundle list content: application/json: schema: type: object example: account_id: 1 active: true created_at: '2018-02-20T14:05:34.029Z' description: My description id: 9 name: My Test App Bundle List partial_match: false tags: - App Bundle Lists operationId: app_bundle_lists_post "/api/v0/app_name_lists": get: summary: Index description: List all app name lists. Supports pagination via page, per, and ids params. 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 app name lists content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - App Name Lists operationId: app_name_lists_get post: summary: Create description: Creating an App Name List requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/app_name_list_create_simple" full: "$ref": "#/components/examples/app_name_list_create_full" required: true responses: '201': description: Created app name list content: application/json: schema: type: object example: account_id: 1 active: true created_at: '2018-02-20T14:05:34.029Z' description: My description id: 12 name: My Test App Name List partial_match: false tags: - App Name Lists operationId: app_name_lists_post "/api/v0/audios": get: summary: Index 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Audios operationId: audios_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/audio_creative_create_simple" full: "$ref": "#/components/examples/audio_creative_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Audios operationId: audios_post "/api/v0/auth": post: summary: Authenticate and get a SpringServe API token description: The returned API token should be used as the contents of the HTTP `Authorization` header in other authenticated API requests. tags: - Auth security: [] parameters: [] responses: '200': description: successful content: application/json: schema: type: object properties: token: type: string description: The token to use in the Authorization header on future requests expiration: type: string description: The expiration timestamp of this token '400': description: bad request - invalid credentials content: application/json: schema: type: object requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: email: type: string examples: - user@magnite.com password: type: string format: password examples: - some_secret_password required: - email - password operationId: auth_post "/api/v0/bid_maps": get: summary: Index (alias) description: Alias for /api/v0/hb_bid_maps 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Bid Maps operationId: bid_maps_get post: summary: Create (alias) requestBody: content: application/json: schema: type: object examples: bid_map_create_simple: "$ref": "#/components/examples/bid_map_create_simple" bid_map_create_full: "$ref": "#/components/examples/bid_map_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Bid Maps operationId: bid_maps_post "/api/v0/bills": get: summary: Index 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Bills operationId: bills_get post: summary: Create requestBody: content: application/json: schema: type: object examples: bill_create_simple: "$ref": "#/components/examples/bill_create_simple" bill_create_full: "$ref": "#/components/examples/bill_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Bills operationId: bills_post "/api/v0/campaigns": get: summary: Index description: List all campaigns. Supports pagination via page, per, and ids params. 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 campaigns content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Campaigns operationId: campaigns_get post: summary: Create description: Creating a Campaign requestBody: content: application/json: schema: type: object examples: managed_simple: "$ref": "#/components/examples/campaign_managed_create_simple" managed_full: "$ref": "#/components/examples/campaign_managed_create_full" direct_connect_simple: "$ref": "#/components/examples/campaign_direct_connect_create_simple" direct_connect_full: "$ref": "#/components/examples/campaign_direct_connect_create_full" tiles_dedup_simple: "$ref": "#/components/examples/campaign_tiles_dedup_create_simple" tiles_dedup_full: "$ref": "#/components/examples/campaign_tiles_dedup_create_full" required: true responses: '201': description: Created campaign content: application/json: schema: type: object example: name: My Campaign has_rate: true rate: 10.0 demand_partner_id: 52 tags: - Campaigns operationId: campaigns_post "/api/v0/city_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/idsParam responses: '200': description: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - City Lists operationId: city_lists_get post: summary: Create requestBody: content: application/json: schema: type: object examples: city_list_create_simple: "$ref": "#/components/examples/city_list_create_simple" city_list_create_full: "$ref": "#/components/examples/city_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - City Lists operationId: city_lists_post "/api/v0/connected_demand": get: summary: Index description: 'Selling strategies (path alias: connected_demand)' 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Connected Demand operationId: connected_demand_get "/api/v0/connected_supply": get: summary: Index description: 'Buying strategies (path alias: connected_supply)' 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Connected Supply operationId: connected_supply_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/buying_strategy_create_simple" full: "$ref": "#/components/examples/buying_strategy_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Connected Supply operationId: connected_supply_post "/api/v0/country_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/idsParam responses: '200': description: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Country Lists operationId: country_lists_get post: summary: Create requestBody: content: application/json: schema: type: object examples: country_list_create_simple: "$ref": "#/components/examples/country_list_create_simple" country_list_create_full: "$ref": "#/components/examples/country_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Country Lists operationId: country_lists_post "/api/v0/creatives": get: summary: Index 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Creatives operationId: creatives_get "/api/v0/deal_id_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/idsParam responses: '200': description: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Deal Id Lists operationId: deal_id_lists_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/deal_id_list_create_simple" full: "$ref": "#/components/examples/deal_id_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Deal Id Lists operationId: deal_id_lists_post "/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 "/api/v0/demand_labels": get: summary: Index description: List all demand labels. Supports pagination via page, per, and ids params. 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 demand labels content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Demand Labels operationId: demand_labels_get post: summary: Create description: Creating a Demand Label requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/demand_label_create_simple" full: "$ref": "#/components/examples/demand_label_create_full" required: true responses: '201': description: Created demand label content: application/json: schema: type: object example: id: 353 name: API Docs label account_id: 1 tags: - Demand Labels operationId: demand_labels_post "/api/v0/demand_partners": get: summary: Index description: List all demand partners. Supports pagination via page, per, and ids params. 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 demand partners content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Demand Partners operationId: demand_partners_get post: summary: Create description: Creating a Demand Partner requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/demand_partner_create_simple" full: "$ref": "#/components/examples/demand_partner_create_full" required: true responses: '201': description: Created demand partner content: application/json: schema: type: object example: account_id: 1 buy_flagged_supply: true default_tier: 1 direct_connect: false id: 1764 name: API Docs partner tags: - Demand Partners operationId: demand_partners_post "/api/v0/demand_tags": get: summary: Index description: Get demand tags based on multiple conditions 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 demand tags content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Demand Tags operationId: demand_tags_get post: summary: Create description: Creating a Demand Tag requestBody: content: application/json: schema: type: object examples: tag_simple: "$ref": "#/components/examples/demand_tag_tag_create_simple" tag_full: "$ref": "#/components/examples/demand_tag_tag_create_full" bidder_simple: "$ref": "#/components/examples/demand_tag_bidder_create_simple" bidder_full: "$ref": "#/components/examples/demand_tag_bidder_create_full" line_item_simple: "$ref": "#/components/examples/demand_tag_line_item_create_simple" line_item_full: "$ref": "#/components/examples/demand_tag_line_item_create_full" house_ad_simple: "$ref": "#/components/examples/demand_tag_house_ad_create_simple" house_ad_full: "$ref": "#/components/examples/demand_tag_house_ad_create_full" dsp_sub_line_item_simple: "$ref": "#/components/examples/demand_tag_dsp_sub_line_item_create_simple" dsp_sub_line_item_full: "$ref": "#/components/examples/demand_tag_dsp_sub_line_item_create_full" marketplace_deal_simple: "$ref": "#/components/examples/demand_tag_marketplace_deal_create_simple" marketplace_deal_full: "$ref": "#/components/examples/demand_tag_marketplace_deal_create_full" required: true responses: '201': description: Created demand tag content: application/json: schema: type: object example: account_id: 1 active: true id: 30424 name: TEST API DOCS rate: '0.01' demand_partner_id: 1764 vast_endpoint_url: https://staging-tv.springserve.com/vast tags: - Demand Tags operationId: demand_tags_post "/api/v0/direct_connection_clearing_terms": get: summary: Index 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Direct Connection Clearing Terms operationId: direct_connection_clearing_terms_get "/api/v0/direct_connections": get: summary: Index description: List direct connections 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Direct Connections operationId: direct_connections_get "/api/v0/domain_lists": get: summary: Index description: List all domain lists. Supports pagination via page, per, and ids params. 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 domain lists content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Domain Lists operationId: domain_lists_get post: summary: Create description: Creating a domain list requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/domain_list_create_simple" full: "$ref": "#/components/examples/domain_list_create_full" required: true responses: '201': description: Created domain list content: application/json: schema: type: object example: description: My description id: 6114 name: My Test Domain List account_id: 1 tags: - Domain Lists operationId: domain_lists_post "/api/v0/forecast": post: summary: Create Forecast description: Create a forecast responses: '200': description: '' content: application/json: schema: type: object tags: - Forecast operationId: forecast_post "/api/v0/global_fcap_pixels": get: summary: Index 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Global Fcap Pixels operationId: global_fcap_pixels_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/global_fcap_pixel_create_simple" full: "$ref": "#/components/examples/global_fcap_pixel_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Global Fcap Pixels operationId: global_fcap_pixels_post "/api/v0/hb_bid_maps": get: summary: Index 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Hb Bid Maps operationId: hb_bid_maps_get post: summary: Create requestBody: content: application/json: schema: type: object examples: hb_bid_map_create_simple: "$ref": "#/components/examples/hb_bid_map_create_simple" hb_bid_map_create_full: "$ref": "#/components/examples/hb_bid_map_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Hb Bid Maps operationId: hb_bid_maps_post "/api/v0/ip_lists": get: summary: Index description: List all IP address lists. Supports pagination via page, per, and ids params. 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 IP address lists content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Ip Lists operationId: ip_lists_get post: summary: Create description: Creating an IP Address List requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/ip_list_create_simple" full: "$ref": "#/components/examples/ip_list_create_full" required: true responses: '201': description: Created IP address list content: application/json: schema: type: object example: id: 6 account_id: 1 name: My IP List description: My description active: true created_at: '2018-08-08T21:06:09.923Z' tags: - Ip Lists operationId: ip_lists_post "/api/v0/keys": get: summary: Index 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Keys operationId: keys_get post: summary: Create requestBody: content: application/json: schema: type: object examples: key_create_simple: "$ref": "#/components/examples/key_create_simple" key_create_full: "$ref": "#/components/examples/key_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Keys operationId: keys_post "/api/v0/metro_area_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/idsParam responses: '200': description: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Metro Area Lists operationId: metro_area_lists_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/metro_area_list_create_simple" full: "$ref": "#/components/examples/metro_area_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Metro Area Lists operationId: metro_area_lists_post "/api/v0/parameter_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/idsParam responses: '200': description: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Parameter Lists operationId: parameter_lists_get post: summary: Create requestBody: content: application/json: schema: type: object examples: parameter_list_create_simple: "$ref": "#/components/examples/parameter_list_create_simple" parameter_list_create_full: "$ref": "#/components/examples/parameter_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Parameter Lists operationId: parameter_lists_post "/api/v0/partner_segments": get: summary: Index 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Partner Segments operationId: partner_segments_get "/api/v0/postal_code_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/idsParam responses: '200': description: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Postal Code Lists operationId: postal_code_lists_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/postal_code_list_create_simple" full: "$ref": "#/components/examples/postal_code_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Postal Code Lists operationId: postal_code_lists_post "/api/v0/publisher_id_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/idsParam responses: '200': description: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Publisher Id Lists operationId: publisher_id_lists_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/publisher_id_list_create_simple" full: "$ref": "#/components/examples/publisher_id_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Publisher Id Lists operationId: publisher_id_lists_post "/api/v0/report": post: summary: Create Report description: Create a Delivery report. Available for ClearLine account types. requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/report_create_simple" full: "$ref": "#/components/examples/report_create_full" responses: '200': description: Report result or queued/building status content: application/json: schema: type: object tags: - Report operationId: report_post "/api/v0/reports": post: summary: Create Report description: | Create a report. For Reach & Frequency reports (ClearLine), include interval, timezone, cadences, and async exactly as shown. Reports may return QUEUED or BUILDING status; repeat the POST until status is COMPLETE. Available for ClearLine account types. requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/report_create_simple" full: "$ref": "#/components/examples/report_create_full" responses: '200': description: Report result. Status may be QUEUED, BUILDING, or COMPLETE. content: application/json: schema: type: object example: status: COMPLETE report_id: "[36-digit report ID]" page: 1 total_pages: 1 total_rows: 1 data: - total_impressions: 3785905 unique_cookies: 3817644 cookie_reach: 0.99 cost: 66048.81 cpm: 17.45 tags: - Reports operationId: reports_post "/api/v0/segments": get: summary: Index description: List all segments. Supports pagination via page, per, and ids params. 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 segments content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Segments operationId: segments_get post: summary: Create description: Creating a Segment requestBody: content: application/json: schema: type: object examples: segment_list_create_simple: "$ref": "#/components/examples/segment_list_create_simple" segment_list_create_full: "$ref": "#/components/examples/segment_list_create_full" segment_pixel_create_simple: "$ref": "#/components/examples/segment_pixel_create_simple" segment_pixel_create_full: "$ref": "#/components/examples/segment_pixel_create_full" required: true responses: '201': description: Created segment content: application/json: schema: type: object example: name: My Cookie ID Segment tags: - Segments operationId: segments_post "/api/v0/state_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/idsParam responses: '200': description: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - State Lists operationId: state_lists_get post: summary: Create requestBody: content: application/json: schema: type: object examples: state_list_create_simple: "$ref": "#/components/examples/state_list_create_simple" state_list_create_full: "$ref": "#/components/examples/state_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - State Lists operationId: state_lists_post "/api/v0/supply_labels": get: summary: Index description: List all supply labels. Supports pagination via page, per, and ids params. 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 supply labels content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Supply Labels operationId: supply_labels_get post: summary: Create description: Creating a Supply Label requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/supply_label_create_simple" full: "$ref": "#/components/examples/supply_label_create_full" required: true responses: '201': description: Created supply label content: application/json: schema: type: object example: id: 353 name: API Docs label account_id: 1 tags: - Supply Labels operationId: supply_labels_post "/api/v0/supply_partners": get: summary: Index description: List all supply partners. Supports pagination via page, per, and ids params. 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 supply partners content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Supply Partners operationId: supply_partners_get post: summary: Create description: Creating a Supply Partner requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/supply_partner_create_simple" full: "$ref": "#/components/examples/supply_partner_create_full" required: true responses: '201': description: Created supply partner content: application/json: schema: type: object example: account_id: 1 direct_connect: true id: 1764 name: API Docs partner optimization_active_default: true optimization_custom_defaults: true optimization_settings_default: lookback_minutes: '30' metric: Request Fill minimum_requests: '100' tags: - Supply Partners operationId: supply_partners_post "/api/v0/supply_routers": get: summary: Index 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Supply Routers operationId: supply_routers_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/supply_router_create_simple" full: "$ref": "#/components/examples/supply_router_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Supply Routers operationId: supply_routers_post "/api/v0/supply_tags": get: summary: Index description: List all supply tags. Supports pagination via page, per, and ids params. 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 supply tags content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Supply Tags operationId: supply_tags_get post: summary: Create description: Create a supply tag requestBody: content: application/json: schema: type: object examples: tag_simple: "$ref": "#/components/examples/supply_tag_tag_create_simple" tag_full: "$ref": "#/components/examples/supply_tag_tag_create_full" bid_link_simple: "$ref": "#/components/examples/supply_tag_bid_link_create_simple" bid_link_full: "$ref": "#/components/examples/supply_tag_bid_link_create_full" tile_simple: "$ref": "#/components/examples/supply_tag_tile_create_simple" tile_full: "$ref": "#/components/examples/supply_tag_tile_create_full" audio_simple: "$ref": "#/components/examples/supply_tag_audio_create_simple" audio_full: "$ref": "#/components/examples/supply_tag_audio_create_full" pause_ad_simple: "$ref": "#/components/examples/supply_tag_pause_ad_create_simple" pause_ad_full: "$ref": "#/components/examples/supply_tag_pause_ad_create_full" required: true responses: '201': description: Created supply tag content: application/json: schema: type: object tags: - Supply Tags operationId: supply_tags_post "/api/v0/tag_creatives": get: summary: Index 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Tag Creatives operationId: tag_creatives_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/tag_creative_create_simple" full: "$ref": "#/components/examples/tag_creative_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Tag Creatives operationId: tag_creatives_post "/api/v0/tiles": get: summary: Index 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Tiles operationId: tiles_get post: summary: Create requestBody: content: application/json: schema: type: object examples: clickable_image_simple: "$ref": "#/components/examples/tile_creative_clickable_image_create_simple" clickable_image_full: "$ref": "#/components/examples/tile_creative_clickable_image_create_full" custom_simple: "$ref": "#/components/examples/tile_creative_custom_create_simple" custom_full: "$ref": "#/components/examples/tile_creative_custom_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Tiles operationId: tiles_post "/api/v0/users": get: summary: Index 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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Users operationId: users_get "/api/v0/value_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/idsParam responses: '200': description: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Value Lists operationId: value_lists_get post: summary: Create requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/value_list_create_simple" full: "$ref": "#/components/examples/value_list_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Value Lists operationId: value_lists_post "/api/v0/videos": get: summary: Index description: List video creatives. Supports pagination via page, per, and ids params. 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 video creatives content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Videos operationId: videos_get post: summary: Create description: Create a video creative (from Clearline Demand Tag, Video Creative API docs) requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/video_creative_create_simple" full: "$ref": "#/components/examples/video_creative_create_full" required: true responses: '201': description: Created video creative content: application/json: schema: type: object example: id: 1832 account_id: 1 name: videofile.mp4 height: 1080 width: 1920 duration_seconds: 14 video_file_name: VIDEO FILE API DOCS video_content_type: video/mp4 video_file_size: 6737024 video_updated_at: '2018-08-20T21:25:27.235Z' video_remote_url: tags: - Videos operationId: videos_post "/api/v0/accounts/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show description: Retrieve a single account by id responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_get put: summary: Update description: Update the account. Only tier flags are updatable via v0 (tier_a_active, tier_b_active, tier_c_active, tier_e_active, tier_f_active). requestBody: content: application/json: schema: type: object properties: tier_a_active: type: boolean tier_b_active: type: boolean tier_c_active: type: boolean tier_e_active: type: boolean tier_f_active: type: boolean examples: simple: "$ref": "#/components/examples/account_update_simple" full: "$ref": "#/components/examples/account_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_put "/api/v0/advertiser_domain_lists/{id}": get: summary: Show description: Get a domain list by ID parameters: - name: id in: path required: true schema: type: string responses: '200': description: Advertiser domain list details content: application/json: schema: type: object example: description: My description id: 123 name: My Test Advertiser Domain List account_id: 1 tags: - Advertiser Domain Lists operationId: advertiser_domain_lists_id_get put: summary: Update description: Update an advertiser domain list parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/advertiser_domain_list_update_simple" full: "$ref": "#/components/examples/advertiser_domain_list_update_full" responses: '200': description: Updated advertiser domain list content: application/json: schema: type: object tags: - Advertiser Domain Lists operationId: advertiser_domain_lists_id_put delete: summary: Destroy description: Delete an advertiser domain list parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Advertiser Domain Lists operationId: advertiser_domain_lists_id_delete "/api/v0/app_bundle_lists/{id}": get: summary: Show description: Get an App Bundle List parameters: - name: id in: path required: true schema: type: string responses: '200': description: App bundle list details content: application/json: schema: type: object example: account_id: 1 active: true created_at: '2018-02-20T14:05:34.029Z' description: My description id: 9 name: My Test App Bundle List partial_match: false tags: - App Bundle Lists operationId: app_bundle_lists_id_get put: summary: Update description: Update an app bundle list parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/app_bundle_list_update_simple" full: "$ref": "#/components/examples/app_bundle_list_update_full" required: true responses: '200': description: Updated app bundle list content: application/json: schema: type: object example: account_id: 1 active: true created_at: '2018-02-20T14:05:34.029Z' description: My description id: 9 name: My Test App Bundle List partial_match: false tags: - App Bundle Lists operationId: app_bundle_lists_id_put delete: summary: Destroy description: Delete an app bundle list parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - App Bundle Lists operationId: app_bundle_lists_id_delete "/api/v0/app_name_lists/{id}": get: summary: Show description: Get an App Name List parameters: - name: id in: path required: true schema: type: string responses: '200': description: App name list details content: application/json: schema: type: object example: account_id: 1 active: true created_at: '2018-02-20T14:05:34.029Z' description: My description id: 12 name: My Test App Name List partial_match: false tags: - App Name Lists operationId: app_name_lists_id_get put: summary: Update description: Update an app name list parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/app_name_list_update_simple" full: "$ref": "#/components/examples/app_name_list_update_full" required: true responses: '200': description: Updated app name list content: application/json: schema: type: object example: account_id: 1 active: true created_at: '2018-02-20T14:05:34.029Z' description: My description id: 12 name: My Test App Name List partial_match: false tags: - App Name Lists operationId: app_name_lists_id_put delete: summary: Destroy description: Delete an app name list parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - App Name Lists operationId: app_name_lists_id_delete "/api/v0/audios/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Audios operationId: audios_id_get put: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/audio_creative_update_simple" full: "$ref": "#/components/examples/audio_creative_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Audios operationId: audios_id_put delete: summary: Destroy parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Audios operationId: audios_id_delete "/api/v0/bid_maps/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show (alias) responses: '200': description: '' content: application/json: schema: type: object tags: - Bid Maps operationId: bid_maps_id_get put: summary: Update (alias) requestBody: content: application/json: schema: type: object examples: bid_map_update_simple: "$ref": "#/components/examples/bid_map_update_simple" bid_map_update_full: "$ref": "#/components/examples/bid_map_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Bid Maps operationId: bid_maps_id_put patch: summary: Update (alias) requestBody: content: application/json: schema: type: object examples: bid_map_update_simple: "$ref": "#/components/examples/bid_map_update_simple" bid_map_update_full: "$ref": "#/components/examples/bid_map_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Bid Maps operationId: bid_maps_id_patch delete: summary: Destroy (alias) responses: '204': description: No content tags: - Bid Maps operationId: bid_maps_id_delete "/api/v0/bills/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Bills operationId: bills_id_get put: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: bill_update_simple: "$ref": "#/components/examples/bill_update_simple" bill_update_full: "$ref": "#/components/examples/bill_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Bills operationId: bills_id_put "/api/v0/campaigns/{id}": get: summary: Show description: Get a Campaign parameters: - name: id in: path required: true schema: type: string responses: '200': description: Campaign details content: application/json: schema: type: object tags: - Campaigns operationId: campaigns_id_get put: summary: Update description: Add Demand Tags to your Campaign or Edit a Campaign parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/campaign_update_simple" full: "$ref": "#/components/examples/campaign_update_full" responses: '200': description: Updated campaign content: application/json: schema: type: object example: id: 39 account_id: 1 name: My Campaign rate: has_rate: false demand_partner_id: 52 demand_tag_ids: - 22312 - 45923 tags: - Campaigns operationId: campaigns_id_put delete: summary: Destroy description: Delete a campaign parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Campaigns operationId: campaigns_id_delete "/api/v0/city_lists/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - City Lists operationId: city_lists_id_get put: summary: Update requestBody: content: application/json: schema: type: object examples: city_list_update_simple: "$ref": "#/components/examples/city_list_update_simple" city_list_update_full: "$ref": "#/components/examples/city_list_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - City Lists operationId: city_lists_id_put delete: summary: Destroy responses: '204': description: No content tags: - City Lists operationId: city_lists_id_delete "/api/v0/connected_demand/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - Connected Demand operationId: connected_demand_id_get put: summary: Update requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/selling_strategy_update_simple" full: "$ref": "#/components/examples/selling_strategy_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Connected Demand operationId: connected_demand_id_put delete: summary: Destroy responses: '204': description: No content tags: - Connected Demand operationId: connected_demand_id_delete "/api/v0/connected_supply/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - Connected Supply operationId: connected_supply_id_get put: summary: Update requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/buying_strategy_update_simple" full: "$ref": "#/components/examples/buying_strategy_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Connected Supply operationId: connected_supply_id_put "/api/v0/country_lists/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - Country Lists operationId: country_lists_id_get put: summary: Update requestBody: content: application/json: schema: type: object examples: country_list_update_simple: "$ref": "#/components/examples/country_list_update_simple" country_list_update_full: "$ref": "#/components/examples/country_list_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Country Lists operationId: country_lists_id_put delete: summary: Destroy responses: '204': description: No content tags: - Country Lists operationId: country_lists_id_delete "/api/v0/creatives/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Creatives operationId: creatives_id_get "/api/v0/deal_id_lists/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Id Lists operationId: deal_id_lists_id_get put: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/deal_id_list_update_simple" full: "$ref": "#/components/examples/deal_id_list_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Id Lists operationId: deal_id_lists_id_put delete: summary: Destroy parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Deal Id Lists operationId: deal_id_lists_id_delete "/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 "/api/v0/demand_labels/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show description: Get a Demand Label responses: '200': description: Demand label details content: application/json: schema: type: object example: id: 1764 name: API Docs label account_id: 1 tags: - Demand Labels operationId: demand_labels_id_get put: summary: Update description: Edit a Demand Label requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/demand_label_update_simple" full: "$ref": "#/components/examples/demand_label_update_full" responses: '200': description: Updated demand label content: application/json: schema: type: object example: id: 353 name: I want to change the name account_id: 1 tags: - Demand Labels operationId: demand_labels_id_put delete: summary: Destroy description: Delete a demand label responses: '204': description: No content tags: - Demand Labels operationId: demand_labels_id_delete "/api/v0/demand_partners/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show description: Get a Demand Partner responses: '200': description: Demand partner details content: application/json: schema: type: object example: account_id: 1 buy_flagged_supply: true default_tier: 1 direct_connect: false id: 1764 name: API Docs partner tags: - Demand Partners operationId: demand_partners_id_get put: summary: Update description: Edit a Demand Partner requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/demand_partner_update_simple" full: "$ref": "#/components/examples/demand_partner_update_full" responses: '200': description: Updated demand partner content: application/json: schema: type: object example: account_id: 1 buy_flagged_supply: true default_tier: 1 direct_connect: false id: 1764 name: I want to change the name tags: - Demand Partners operationId: demand_partners_id_put delete: summary: Destroy description: Delete a demand partner responses: '204': description: No content tags: - Demand Partners operationId: demand_partners_id_delete "/api/v0/demand_tags/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show description: Get a demand tag by id responses: '200': description: Demand tag details content: application/json: schema: type: object example: account_id: 1 active: true id: 30424 name: TEST API DOCS rate: '0.01' demand_partner_id: 1764 vast_endpoint_url: https://staging-tv.springserve.com/vast tags: - Demand Tags operationId: demand_tags_id_get put: summary: Update description: Edit a Demand Tag (e.g. name, or budgets). See Clearline Demand Tag Budgets API docs for budget fields. requestBody: content: application/json: schema: type: object properties: advanced_floor_rules: type: array items: type: object properties: id: type: integer dimension: type: string enum: - adomain - duration - country - iab_tier_1 - iab_tier_2 values: type: array items: type: string floor_price: type: number examples: simple: "$ref": "#/components/examples/demand_tag_update_simple" full: "$ref": "#/components/examples/demand_tag_update_full" responses: '200': description: Updated demand tag content: application/json: schema: type: object example: account_id: 1 active: true demand_partner_id: 1764 id: 30424 name: I want to change the name rate: '0.01' vast_endpoint_url: https://staging-tv.springserve.com/vast tags: - Demand Tags operationId: demand_tags_id_put delete: summary: Destroy description: Delete a demand tag responses: '204': description: No content tags: - Demand Tags operationId: demand_tags_id_delete "/api/v0/direct_connection_clearing_terms/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Direct Connection Clearing Terms operationId: direct_connection_clearing_terms_id_get "/api/v0/direct_connections/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Direct Connections operationId: direct_connections_id_get "/api/v0/domain_lists/{id}": get: summary: Show description: Get a domain list by ID parameters: - name: id in: path required: true schema: type: string responses: '200': description: Domain list details content: application/json: schema: type: object example: description: My description id: 6114 name: My Test Domain List account_id: 1 tags: - Domain Lists operationId: domain_lists_id_get put: summary: Update description: Update a domain list parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/domain_list_update_simple" full: "$ref": "#/components/examples/domain_list_update_full" responses: '200': description: Updated domain list content: application/json: schema: type: object example: description: My description id: 6114 name: My Test Domain List account_id: 1 tags: - Domain Lists operationId: domain_lists_id_put delete: summary: Destroy description: Delete a domain list parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Domain Lists operationId: domain_lists_id_delete "/api/v0/first_party_partner_segments/{id}": parameters: - name: id in: path required: true schema: type: string delete: summary: Destroy responses: '204': description: No content tags: - First Party Partner Segments operationId: first_party_partner_segments_id_delete "/api/v0/global_fcap_pixels/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Global Fcap Pixels operationId: global_fcap_pixels_id_get put: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/global_fcap_pixel_update_simple" full: "$ref": "#/components/examples/global_fcap_pixel_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Global Fcap Pixels operationId: global_fcap_pixels_id_put delete: summary: Destroy parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Global Fcap Pixels operationId: global_fcap_pixels_id_delete "/api/v0/hb_bid_maps/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - Hb Bid Maps operationId: hb_bid_maps_id_get put: summary: Update requestBody: content: application/json: schema: type: object examples: hb_bid_map_update_simple: "$ref": "#/components/examples/hb_bid_map_update_simple" hb_bid_map_update_full: "$ref": "#/components/examples/hb_bid_map_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Hb Bid Maps operationId: hb_bid_maps_id_put patch: summary: Update requestBody: content: application/json: schema: type: object examples: hb_bid_map_update_simple: "$ref": "#/components/examples/hb_bid_map_update_simple" hb_bid_map_update_full: "$ref": "#/components/examples/hb_bid_map_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Hb Bid Maps operationId: hb_bid_maps_id_patch delete: summary: Destroy responses: '204': description: No content tags: - Hb Bid Maps operationId: hb_bid_maps_id_delete "/api/v0/ip_lists/{id}": get: summary: Show description: Get an IP Address List parameters: - name: id in: path required: true schema: type: string responses: '200': description: IP address list details content: application/json: schema: type: object example: id: 6 account_id: 1 name: My IP List description: My description active: true created_at: '2018-08-08T17:19:44.516Z' tags: - Ip Lists operationId: ip_lists_id_get put: summary: Update description: Update an IP address list parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/ip_list_update_simple" full: "$ref": "#/components/examples/ip_list_update_full" required: true responses: '200': description: Updated IP address list content: application/json: schema: type: object example: id: 6 account_id: 1 name: My IP List description: My description active: true created_at: '2018-08-08T17:19:44.516Z' tags: - Ip Lists operationId: ip_lists_id_put delete: summary: Destroy description: Delete an IP address list parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Ip Lists operationId: ip_lists_id_delete "/api/v0/keys/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Keys operationId: keys_id_get put: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: key_update_simple: "$ref": "#/components/examples/key_update_simple" key_update_full: "$ref": "#/components/examples/key_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Keys operationId: keys_id_put delete: summary: Destroy parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Keys operationId: keys_id_delete "/api/v0/metro_area_lists/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - Metro Area Lists operationId: metro_area_lists_id_get put: summary: Update requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/metro_area_list_update_simple" full: "$ref": "#/components/examples/metro_area_list_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Metro Area Lists operationId: metro_area_lists_id_put delete: summary: Destroy responses: '204': description: No content tags: - Metro Area Lists operationId: metro_area_lists_id_delete "/api/v0/parameter_lists/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Parameter Lists operationId: parameter_lists_id_get put: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: parameter_list_update_simple: "$ref": "#/components/examples/parameter_list_update_simple" parameter_list_update_full: "$ref": "#/components/examples/parameter_list_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Parameter Lists operationId: parameter_lists_id_put delete: summary: Destroy parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Parameter Lists operationId: parameter_lists_id_delete "/api/v0/partner_segments/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - Partner Segments operationId: partner_segments_id_get put: summary: Update requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/partner_segment_update_simple" full: "$ref": "#/components/examples/partner_segment_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Partner Segments operationId: partner_segments_id_put delete: summary: Destroy responses: '204': description: No content tags: - Partner Segments operationId: partner_segments_id_delete "/api/v0/postal_code_lists/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - Postal Code Lists operationId: postal_code_lists_id_get put: summary: Update requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/postal_code_list_update_simple" full: "$ref": "#/components/examples/postal_code_list_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Postal Code Lists operationId: postal_code_lists_id_put delete: summary: Destroy responses: '204': description: No content tags: - Postal Code Lists operationId: postal_code_lists_id_delete "/api/v0/programmatic_guaranteed/{id}": parameters: - name: id in: path required: true schema: type: string "/api/v0/publisher_id_lists/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Publisher Id Lists operationId: publisher_id_lists_id_get put: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/publisher_id_list_update_simple" full: "$ref": "#/components/examples/publisher_id_list_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Publisher Id Lists operationId: publisher_id_lists_id_put delete: summary: Destroy parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Publisher Id Lists operationId: publisher_id_lists_id_delete "/api/v0/segments/{id}": get: summary: Show description: Get a segment parameters: - name: id in: path required: true schema: type: string responses: '200': description: Segment details content: application/json: schema: type: object example: id: 10044 account_id: 1 name: My DID Segment description: My description active: true segment_type: list segment_list_type: cookie created_at: '2020-03-18T19:17:01.383Z' tags: - Segments operationId: segments_id_get put: summary: Update description: Update a segment parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: segment_update_simple: "$ref": "#/components/examples/segment_update_simple" segment_update_full: "$ref": "#/components/examples/segment_update_full" responses: '200': description: Updated segment content: application/json: schema: type: object tags: - Segments operationId: segments_id_put delete: summary: Destroy description: Delete a segment parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Segments operationId: segments_id_delete "/api/v0/state_lists/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - State Lists operationId: state_lists_id_get put: summary: Update requestBody: content: application/json: schema: type: object examples: state_list_update_simple: "$ref": "#/components/examples/state_list_update_simple" state_list_update_full: "$ref": "#/components/examples/state_list_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - State Lists operationId: state_lists_id_put delete: summary: Destroy responses: '204': description: No content tags: - State Lists operationId: state_lists_id_delete "/api/v0/supply_labels/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show description: Get a Supply Label responses: '200': description: Supply label details content: application/json: schema: type: object example: id: 1764 name: API Docs label account_id: 1 tags: - Supply Labels operationId: supply_labels_id_get put: summary: Update description: Edit a Supply Label requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/supply_label_update_simple" full: "$ref": "#/components/examples/supply_label_update_full" responses: '200': description: Updated supply label content: application/json: schema: type: object example: id: 353 name: I want to change the name account_id: 1 tags: - Supply Labels operationId: supply_labels_id_put delete: summary: Destroy description: Delete a supply label responses: '204': description: No content tags: - Supply Labels operationId: supply_labels_id_delete "/api/v0/supply_partners/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show description: Get a Supply Partner responses: '200': description: Supply partner details content: application/json: schema: type: object example: account_id: 1 direct_connect: true id: 1764 name: API Docs partner optimization_active_default: true optimization_custom_defaults: true optimization_settings_default: lookback_minutes: '30' metric: Request Fill minimum_requests: '100' tags: - Supply Partners operationId: supply_partners_id_get put: summary: Update description: Edit a Supply Partner requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/supply_partner_update_simple" full: "$ref": "#/components/examples/supply_partner_update_full" responses: '200': description: Updated supply partner content: application/json: schema: type: object example: account_id: 1 direct_connect: true id: 1764 name: I want to change the name optimization_active_default: true optimization_custom_defaults: true optimization_settings_default: lookback_minutes: '30' metric: Request Fill minimum_requests: '100' tags: - Supply Partners operationId: supply_partners_id_put delete: summary: Destroy description: Delete a supply partner responses: '204': description: No content tags: - Supply Partners operationId: supply_partners_id_delete "/api/v0/supply_routers/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - Supply Routers operationId: supply_routers_id_get put: summary: Update requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/supply_router_update_simple" full: "$ref": "#/components/examples/supply_router_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Supply Routers operationId: supply_routers_id_put delete: summary: Destroy responses: '204': description: No content tags: - Supply Routers operationId: supply_routers_id_delete "/api/v0/supply_tags/{id}": parameters: - name: id in: path required: true schema: type: string get: summary: Show description: Get a supply tag by id responses: '200': description: Supply tag details content: application/json: schema: type: object tags: - Supply Tags operationId: supply_tags_id_get put: summary: Update description: Update a supply tag (e.g. Adding Pods, Content Targeting) requestBody: content: application/json: schema: type: object properties: advanced_floor_rules: type: array items: type: object properties: id: type: integer dimension: type: string enum: - adomain - duration - country - iab_tier_1 - iab_tier_2 values: type: array items: type: string floor_price: type: number examples: simple: "$ref": "#/components/examples/supply_tag_update_simple" full: "$ref": "#/components/examples/supply_tag_update_full" responses: '200': description: Updated supply tag content: application/json: schema: type: object tags: - Supply Tags operationId: supply_tags_id_put delete: summary: Destroy description: Delete a supply tag responses: '204': description: No content tags: - Supply Tags operationId: supply_tags_id_delete "/api/v0/tag_creatives/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Tag Creatives operationId: tag_creatives_id_get put: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/tag_creative_update_simple" full: "$ref": "#/components/examples/tag_creative_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Tag Creatives operationId: tag_creatives_id_put delete: summary: Destroy parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Tag Creatives operationId: tag_creatives_id_delete "/api/v0/tiles/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Tiles operationId: tiles_id_get put: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/tile_creative_update_simple" full: "$ref": "#/components/examples/tile_creative_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Tiles operationId: tiles_id_put delete: summary: Destroy parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Tiles operationId: tiles_id_delete "/api/v0/users/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Users operationId: users_id_get "/api/v0/value_lists/{id}": get: summary: Show parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Value Lists operationId: value_lists_id_get put: summary: Update parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/value_list_update_simple" full: "$ref": "#/components/examples/value_list_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Value Lists operationId: value_lists_id_put delete: summary: Destroy parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Value Lists operationId: value_lists_id_delete "/api/v0/videos/{id}": get: summary: Show description: Get a Video Creative parameters: - name: id in: path required: true schema: type: string responses: '200': description: Video creative details content: application/json: schema: type: object example: id: 1832 account_id: 1 name: videofile.mp4 height: 1080 width: 1920 duration_seconds: 14 video_file_name: VIDEO FILE API DOCS video_content_type: video/mp4 video_file_size: 6737024 video_updated_at: '2018-08-20T21:25:27.235Z' video_remote_url: tags: - Videos operationId: videos_id_get put: summary: Update description: Update a video creative parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: simple: "$ref": "#/components/examples/video_creative_update_simple" full: "$ref": "#/components/examples/video_creative_update_full" responses: '200': description: Updated video creative content: application/json: schema: type: object tags: - Videos operationId: videos_id_put delete: summary: Destroy description: Delete a video creative parameters: - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Videos operationId: videos_id_delete "/api/v0/accounts/current": get: summary: Get Current description: Get the currently active account for the authenticated user responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_current_get "/api/v0/auth0/login": post: summary: Authenticate and get user and account info description: Authenticate the user, and if valid, return basic info about the user, along with accounts they can access tags: - Auth security: [] parameters: [] responses: '200': description: successful content: application/json: schema: type: object '400': description: bad request - invalid credentials content: application/json: schema: type: object requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: email: type: string examples: - user@magnite.com password: type: string format: password examples: - some_secret_password required: - email - password operationId: auth0_login_post "/api/v0/first_party_partner_segments/bulk_create": post: summary: Bulk Create requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/first_party_partner_segment_bulk_create_single" multiple: "$ref": "#/components/examples/first_party_partner_segment_bulk_create_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - First Party Partner Segments operationId: first_party_partner_segments_bulk_create_post "/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 "/api/v0/partner_segments/bulk_create": post: summary: Bulk Create requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/partner_segment_bulk_create_single" multiple: "$ref": "#/components/examples/partner_segment_bulk_create_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Partner Segments operationId: partner_segments_bulk_create_post "/api/v0/accounts/{id}/set_current": post: summary: Set Current description: Set the active account for the authenticated user to the specified account id parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Accounts operationId: accounts_id_set_current_post "/api/v0/advertiser_domain_lists/{advertiser_domain_list_id}/advertiser_domains": get: summary: Index description: Get domains in advertiser domain list parameters: - name: advertiser_domain_list_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 advertiser domains content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse example: - name: cnn.com - name: abc.com tags: - Advertiser Domain Lists operationId: advertiser_domain_lists_advertiser_domain_list_id_advertiser_domains_get "/api/v0/app_bundle_lists/{app_bundle_list_id}/app_bundles": get: summary: Index description: Get App Bundles in App Bundle List parameters: - name: app_bundle_list_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 app bundles content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse example: - app_bundle: app1 - app_bundle: app2 tags: - App Bundle Lists operationId: app_bundle_lists_app_bundle_list_id_app_bundles_get "/api/v0/app_name_lists/{app_name_list_id}/app_names": get: summary: Index description: Get App Names in App Name List parameters: - name: app_name_list_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 app names content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse example: - app_name: app1 - app_name: app2 tags: - App Name Lists operationId: app_name_lists_app_name_list_id_app_names_get "/api/v0/bills/{bill_id}/bill_items": get: summary: Index description: List bill items for a bill parameters: - name: bill_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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Bills operationId: bills_bill_id_bill_items_get post: summary: Create parameters: - name: bill_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: bill_item_create_simple: "$ref": "#/components/examples/bill_item_create_simple" bill_item_create_full: "$ref": "#/components/examples/bill_item_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Bills operationId: bills_bill_id_bill_items_post "/api/v0/connected_demand/{id}/duplicate": get: summary: Duplicate description: Duplicate the selling strategy (connected demand) parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Connected Demand operationId: connected_demand_id_duplicate_get "/api/v0/connected_supply/{id}/duplicate": get: summary: Duplicate description: Duplicate the buying strategy parameters: - name: id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Connected Supply operationId: connected_supply_id_duplicate_get "/api/v0/deal_id_lists/{deal_id_list_id}/deal_ids": get: summary: Index parameters: - name: deal_id_list_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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Deal Id Lists operationId: deal_id_lists_deal_id_list_id_deal_ids_get "/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 "/api/v0/demand_tags/{demand_tag_id}/demand_tag_keys": get: summary: Index description: List demand tag keys for a demand tag parameters: - name: demand_tag_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 demand tag keys content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Demand Tags operationId: demand_tags_demand_tag_id_demand_tag_keys_get post: summary: Create parameters: - name: demand_tag_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: demand_tag_key_create_simple: "$ref": "#/components/examples/demand_tag_key_create_simple" demand_tag_key_create_full: "$ref": "#/components/examples/demand_tag_key_create_full" required: true responses: '201': description: Created demand tag key content: application/json: schema: type: object tags: - Demand Tags operationId: demand_tags_demand_tag_id_demand_tag_keys_post "/api/v0/demand_tags/{id}/duplicate": get: summary: Duplicate description: Duplicate a Demand Tag parameters: - name: id in: path required: true schema: type: string responses: '200': description: Duplicated demand tag content: application/json: schema: type: object example: account_id: 1 active: true demand_partner_id: 1764 id: 72302 name: I want to change the name (copy) rate: '0.01' vast_endpoint_url: https://staging-tv.springserve.com/vast tags: - Demand Tags operationId: demand_tags_id_duplicate_get "/api/v0/domain_lists/{domain_list_id}/domains": get: summary: Index domains description: Get domains in domain list parameters: - name: domain_list_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 domains content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse example: - name: cnn.com - name: abc.com tags: - Domain Lists operationId: domain_lists_domain_list_id_domains_get "/api/v0/ip_lists/{ip_list_id}/ips": get: summary: Index description: Get IP Addresses in an IP Address List parameters: - name: ip_list_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 IP addresses content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse example: - ip: 158.106.194.74 - ip: 158.106.194.75 tags: - Ip Lists operationId: ip_lists_ip_list_id_ips_get "/api/v0/keys/{key_id}/values": get: summary: Index parameters: - name: key_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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Keys operationId: keys_key_id_values_get post: summary: Create parameters: - name: key_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: key_value_create_simple: "$ref": "#/components/examples/key_value_create_simple" key_value_create_full: "$ref": "#/components/examples/key_value_create_full" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Keys operationId: keys_key_id_values_post "/api/v0/parameter_lists/{parameter_list_id}/values": get: summary: Index parameters: - name: parameter_list_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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Parameter Lists operationId: parameter_lists_parameter_list_id_values_get "/api/v0/publisher_id_lists/{publisher_id_list_id}/publisher_ids": get: summary: Index parameters: - name: publisher_id_list_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: '' content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse tags: - Publisher Id Lists operationId: publisher_id_lists_publisher_id_list_id_publisher_ids_get "/api/v0/segments/{segment_id}/items": get: summary: Index description: Get Device IDs or Cookies in a Segment parameters: - name: segment_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 segment items content: application/json: schema: "$ref": ref/schemas.yaml#/components/schemas/ListResponse example: - item: d207654f-6bdd-474e-9734-67b7c3d02d96 - item: d20gt57i-6bdd-474e-9734-67b7c3d02d96 tags: - Segments operationId: segments_segment_id_items_get "/api/v0/supply_tags/{id}/duplicate": get: summary: Duplicate description: Duplicate a Supply Tag parameters: - name: id in: path required: true schema: type: string responses: '200': description: Duplicated supply tag content: application/json: schema: type: object example: id: 65034 name: I want to change the name rate: '0.02' tags: - Supply Tags operationId: supply_tags_id_duplicate_get "/api/v0/auth0/users/{email}": get: summary: Retrieve basic info about a user by email address description: If a user can be found with the provided email address, return the platform_type and role from their active user_account. Token based authentication (Authorization header) is required. tags: - Auth parameters: - name: email in: path required: true schema: type: string examples: - user@magnite.com responses: '200': description: successful content: application/json: schema: type: object '400': description: bad request - invalid credentials content: application/json: schema: type: object operationId: auth0_users_email_get "/api/v0/advertiser_domain_lists/{advertiser_domain_list_id}/advertiser_domains/bulk_create": post: summary: Bulk Create description: Add advertiser domains parameters: - name: advertiser_domain_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/advertiser_domain_list_domains_bulk_single" multiple: "$ref": "#/components/examples/advertiser_domain_list_domains_bulk_multiple" required: true responses: '201': description: Number of domains created content: application/json: schema: type: object example: created: 2 tags: - Advertiser Domain Lists operationId: advertiser_domain_lists_advertiser_domain_list_id_advertiser_domains_bulk_create_post "/api/v0/advertiser_domain_lists/{advertiser_domain_list_id}/advertiser_domains/bulk_delete": delete: summary: Bulk Delete description: Remove domains parameters: - name: advertiser_domain_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object example: names: - cnn.com responses: '200': description: Number of domains deleted content: application/json: schema: type: object example: deleted: 1 tags: - Advertiser Domain Lists operationId: advertiser_domain_lists_advertiser_domain_list_id_advertiser_domains_bulk_delete_delete "/api/v0/advertiser_domain_lists/{advertiser_domain_list_id}/advertiser_domains/bulk_replace": post: summary: Bulk Replace description: Replace advertiser domains parameters: - name: advertiser_domain_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/advertiser_domain_list_domains_bulk_single" multiple: "$ref": "#/components/examples/advertiser_domain_list_domains_bulk_multiple" required: true responses: '200': description: Replacement confirmation content: application/json: schema: type: object example: advertiser: - replacement.com tags: - Advertiser Domain Lists operationId: advertiser_domain_lists_advertiser_domain_list_id_advertiser_domains_bulk_replace_post "/api/v0/advertiser_domain_lists/{advertiser_domain_list_id}/advertiser_domains/file_bulk_create": post: summary: File Bulk Create description: Append advertiser domains to an advertiser domain list from a file parameters: - name: advertiser_domain_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing domains to append (one per line or appropriately formatted) required: true responses: '201': description: Append confirmation content: application/json: schema: type: object example: created: true tags: - Advertiser Domain Lists operationId: advertiser_domain_lists_advertiser_domain_list_id_advertiser_domains_file_bulk_create_post "/api/v0/advertiser_domain_lists/{advertiser_domain_list_id}/advertiser_domains/file_bulk_delete": delete: summary: File Bulk Delete description: Remove domains in a file from an advertiser domain list parameters: - name: advertiser_domain_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing domains to remove from the list responses: '200': description: Deletion confirmation content: application/json: schema: type: object example: created: true tags: - Advertiser Domain Lists operationId: advertiser_domain_lists_advertiser_domain_list_id_advertiser_domains_file_bulk_delete_delete "/api/v0/advertiser_domain_lists/{advertiser_domain_list_id}/advertiser_domains/file_bulk_replace": post: summary: File Bulk Replace description: Replace all domains with a file parameters: - name: advertiser_domain_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing domains to replace existing list contents required: true responses: '200': description: Replacement confirmation content: application/json: schema: type: object example: created: true tags: - Advertiser Domain Lists operationId: advertiser_domain_lists_advertiser_domain_list_id_advertiser_domains_file_bulk_replace_post "/api/v0/app_bundle_lists/{app_bundle_list_id}/app_bundles/bulk_create": post: summary: Bulk Create description: Add App Bundles parameters: - name: app_bundle_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/app_bundle_list_bundles_bulk_single" multiple: "$ref": "#/components/examples/app_bundle_list_bundles_bulk_multiple" required: true responses: '201': description: Created app bundles content: application/json: schema: type: object example: created: true tags: - App Bundle Lists operationId: app_bundle_lists_app_bundle_list_id_app_bundles_bulk_create_post "/api/v0/app_bundle_lists/{app_bundle_list_id}/app_bundles/bulk_delete": delete: summary: Bulk Delete description: Remove App Bundles parameters: - name: app_bundle_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object example: app_bundles: - app2 responses: '200': description: Deleted app bundles content: application/json: schema: type: object example: deleted: true tags: - App Bundle Lists operationId: app_bundle_lists_app_bundle_list_id_app_bundles_bulk_delete_delete "/api/v0/app_bundle_lists/{app_bundle_list_id}/app_bundles/bulk_replace": post: summary: Bulk Replace description: Replace Entire App Bundle List parameters: - name: app_bundle_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/app_bundle_list_bundles_bulk_single" multiple: "$ref": "#/components/examples/app_bundle_list_bundles_bulk_multiple" required: true responses: '200': description: Replaced app bundles content: application/json: schema: type: object example: created: true tags: - App Bundle Lists operationId: app_bundle_lists_app_bundle_list_id_app_bundles_bulk_replace_post "/api/v0/app_bundle_lists/{app_bundle_list_id}/app_bundles/file_bulk_create": post: summary: File Bulk Create description: Add App Bundles from a File parameters: - name: app_bundle_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing app bundles to append required: true responses: '201': description: Append confirmation content: application/json: schema: type: object example: created: true tags: - App Bundle Lists operationId: app_bundle_lists_app_bundle_list_id_app_bundles_file_bulk_create_post "/api/v0/app_bundle_lists/{app_bundle_list_id}/app_bundles/file_bulk_delete": delete: summary: File Bulk Delete description: Remove App Bundles Using a File parameters: - name: app_bundle_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing app bundles to remove responses: '200': description: Deletion confirmation content: application/json: schema: type: object example: deleted: true tags: - App Bundle Lists operationId: app_bundle_lists_app_bundle_list_id_app_bundles_file_bulk_delete_delete "/api/v0/app_bundle_lists/{app_bundle_list_id}/app_bundles/file_bulk_replace": post: summary: File Bulk Replace description: Replace Entire App Bundles with a File parameters: - name: app_bundle_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing app bundles to replace existing list required: true responses: '200': description: Replacement confirmation content: application/json: schema: type: object example: created: true tags: - App Bundle Lists operationId: app_bundle_lists_app_bundle_list_id_app_bundles_file_bulk_replace_post "/api/v0/app_name_lists/{app_name_list_id}/app_names/bulk_create": post: summary: Bulk Create description: Add App Names parameters: - name: app_name_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/app_name_list_names_bulk_single" multiple: "$ref": "#/components/examples/app_name_list_names_bulk_multiple" required: true responses: '201': description: Created app names content: application/json: schema: type: object example: created: true tags: - App Name Lists operationId: app_name_lists_app_name_list_id_app_names_bulk_create_post "/api/v0/app_name_lists/{app_name_list_id}/app_names/bulk_delete": delete: summary: Bulk Delete description: Remove App Names parameters: - name: app_name_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object example: app_names: - app2 responses: '200': description: Deleted app names content: application/json: schema: type: object example: deleted: true tags: - App Name Lists operationId: app_name_lists_app_name_list_id_app_names_bulk_delete_delete "/api/v0/app_name_lists/{app_name_list_id}/app_names/bulk_replace": post: summary: Bulk Replace description: Replace Entire App Name List parameters: - name: app_name_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/app_name_list_names_bulk_single" multiple: "$ref": "#/components/examples/app_name_list_names_bulk_multiple" required: true responses: '200': description: Replaced app names content: application/json: schema: type: object example: created: true tags: - App Name Lists operationId: app_name_lists_app_name_list_id_app_names_bulk_replace_post "/api/v0/app_name_lists/{app_name_list_id}/app_names/file_bulk_create": post: summary: File Bulk Create description: Add App Names from a File parameters: - name: app_name_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing app names to append required: true responses: '201': description: Append confirmation content: application/json: schema: type: object example: created: true tags: - App Name Lists operationId: app_name_lists_app_name_list_id_app_names_file_bulk_create_post "/api/v0/app_name_lists/{app_name_list_id}/app_names/file_bulk_delete": delete: summary: File Bulk Delete description: Remove App Names using a file parameters: - name: app_name_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing app names to remove responses: '200': description: Deletion confirmation content: application/json: schema: type: object example: deleted: true tags: - App Name Lists operationId: app_name_lists_app_name_list_id_app_names_file_bulk_delete_delete "/api/v0/app_name_lists/{app_name_list_id}/app_names/file_bulk_replace": post: summary: File Bulk Replace description: Replace Entire App Name List with a File parameters: - name: app_name_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing app names to replace existing list required: true responses: '200': description: Replacement confirmation content: application/json: schema: type: object example: created: true tags: - App Name Lists operationId: app_name_lists_app_name_list_id_app_names_file_bulk_replace_post "/api/v0/bills/{bill_id}/bill_items/{id}": parameters: - name: bill_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string get: summary: Show responses: '200': description: '' content: application/json: schema: type: object tags: - Bills operationId: bills_bill_id_bill_items_id_get put: summary: Update requestBody: content: application/json: schema: type: object examples: bill_item_update_simple: "$ref": "#/components/examples/bill_item_update_simple" bill_item_update_full: "$ref": "#/components/examples/bill_item_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Bills operationId: bills_bill_id_bill_items_id_put "/api/v0/deal_id_lists/{deal_id_list_id}/deal_ids/bulk_create": post: summary: Bulk Create parameters: - name: deal_id_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/deal_id_list_deal_ids_bulk_create_single" multiple: "$ref": "#/components/examples/deal_id_list_deal_ids_bulk_create_multiple" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Deal Id Lists operationId: deal_id_lists_deal_id_list_id_deal_ids_bulk_create_post "/api/v0/deal_id_lists/{deal_id_list_id}/deal_ids/bulk_delete": delete: summary: Bulk Delete parameters: - name: deal_id_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Id Lists operationId: deal_id_lists_deal_id_list_id_deal_ids_bulk_delete_delete "/api/v0/deal_id_lists/{deal_id_list_id}/deal_ids/bulk_replace": post: summary: Bulk Replace parameters: - name: deal_id_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/deal_id_list_deal_ids_bulk_replace_single" multiple: "$ref": "#/components/examples/deal_id_list_deal_ids_bulk_replace_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Deal Id Lists operationId: deal_id_lists_deal_id_list_id_deal_ids_bulk_replace_post "/api/v0/deal_id_lists/{deal_id_list_id}/deal_ids/file_bulk_create": post: summary: File Bulk Create description: Append deal IDs to a list from a CSV file parameters: - name: deal_id_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing deal IDs to append required: true responses: '201': description: Append confirmation content: application/json: schema: type: object example: created: true tags: - Deal Id Lists operationId: deal_id_lists_deal_id_list_id_deal_ids_file_bulk_create_post "/api/v0/deal_id_lists/{deal_id_list_id}/deal_ids/file_bulk_delete": delete: summary: File Bulk Delete description: Remove deal IDs specified in a CSV file from the list parameters: - name: deal_id_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing deal IDs to remove responses: '200': description: Deletion confirmation content: application/json: schema: type: object example: deleted: true tags: - Deal Id Lists operationId: deal_id_lists_deal_id_list_id_deal_ids_file_bulk_delete_delete "/api/v0/deal_id_lists/{deal_id_list_id}/deal_ids/file_bulk_replace": post: summary: File Bulk Replace description: Replace all deal IDs in a list with contents of a CSV file parameters: - name: deal_id_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing deal IDs to replace existing list required: true responses: '200': description: Replacement confirmation content: application/json: schema: type: object example: created: true tags: - Deal Id Lists operationId: deal_id_lists_deal_id_list_id_deal_ids_file_bulk_replace_post "/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 "/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 "/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 "/api/v0/demand_tags/{demand_tag_id}/demand_tag_keys/{id}": get: summary: Show parameters: - name: demand_tag_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: Demand tag key details content: application/json: schema: type: object tags: - Demand Tags operationId: demand_tags_demand_tag_id_demand_tag_keys_id_get put: summary: Update parameters: - name: demand_tag_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: demand_tag_key_update_simple: "$ref": "#/components/examples/demand_tag_key_update_simple" demand_tag_key_update_full: "$ref": "#/components/examples/demand_tag_key_update_full" responses: '200': description: Updated demand tag key content: application/json: schema: type: object tags: - Demand Tags operationId: demand_tags_demand_tag_id_demand_tag_keys_id_put delete: summary: Destroy parameters: - name: demand_tag_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string responses: '204': description: No content tags: - Demand Tags operationId: demand_tags_demand_tag_id_demand_tag_keys_id_delete "/api/v0/domain_lists/{domain_list_id}/domains/bulk_create": post: summary: Bulk create domains description: Add domains parameters: - name: domain_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/domain_list_domains_bulk_create_single" multiple: "$ref": "#/components/examples/domain_list_domains_bulk_create_multiple" required: true responses: '201': description: Number of domains created content: application/json: schema: type: object example: created: 2 tags: - Domain Lists operationId: domain_lists_domain_list_id_domains_bulk_create_post "/api/v0/domain_lists/{domain_list_id}/domains/bulk_delete": delete: summary: Bulk delete domains description: Remove domains parameters: - name: domain_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object example: names: - cnn.com responses: '200': description: Number of domains deleted content: application/json: schema: type: object example: deleted: 1 tags: - Domain Lists operationId: domain_lists_domain_list_id_domains_bulk_delete_delete "/api/v0/domain_lists/{domain_list_id}/domains/bulk_replace": post: summary: Bulk replace domains description: Replace domains in the list parameters: - name: domain_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/domain_list_domains_bulk_replace_single" multiple: "$ref": "#/components/examples/domain_list_domains_bulk_replace_multiple" required: true responses: '200': description: Replaced domains content: application/json: schema: type: object example: names: - replacement.com tags: - Domain Lists operationId: domain_lists_domain_list_id_domains_bulk_replace_post "/api/v0/domain_lists/{domain_list_id}/domains/file_bulk_create": post: summary: File Bulk Create description: Append domains to a domain list from a CSV file parameters: - name: domain_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing domains to append (one per line or appropriately formatted) required: true responses: '201': description: Append confirmation content: application/json: schema: type: object example: created: true tags: - Domain Lists operationId: domain_lists_domain_list_id_domains_file_bulk_create_post "/api/v0/domain_lists/{domain_list_id}/domains/file_bulk_delete": delete: summary: File Bulk Delete description: Remove domains in a file from a domain list parameters: - name: domain_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing domains to remove from the list responses: '200': description: Deletion confirmation content: application/json: schema: type: object example: deleted: true tags: - Domain Lists operationId: domain_lists_domain_list_id_domains_file_bulk_delete_delete "/api/v0/domain_lists/{domain_list_id}/domains/file_bulk_replace": post: summary: File Bulk Replace description: Replace all domains in a domain list with contents of a CSV file parameters: - name: domain_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing domains to replace existing list contents required: true responses: '200': description: Replacement confirmation content: application/json: schema: type: object example: created: true tags: - Domain Lists operationId: domain_lists_domain_list_id_domains_file_bulk_replace_post "/api/v0/ip_lists/{ip_list_id}/ips/bulk_create": post: summary: Bulk Create description: Add IPs to an Address list parameters: - name: ip_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/ip_list_ips_bulk_create_single" multiple: "$ref": "#/components/examples/ip_list_ips_bulk_create_multiple" required: true responses: '201': description: Created IPs content: application/json: schema: type: object example: created: true tags: - Ip Lists operationId: ip_lists_ip_list_id_ips_bulk_create_post "/api/v0/ip_lists/{ip_list_id}/ips/bulk_delete": delete: summary: Bulk Delete description: Remove specific IP Addresses parameters: - name: ip_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object example: ips: - 158.106.194.74 responses: '200': description: Deleted IPs content: application/json: schema: type: object example: deleted: true tags: - Ip Lists operationId: ip_lists_ip_list_id_ips_bulk_delete_delete "/api/v0/ip_lists/{ip_list_id}/ips/bulk_replace": post: summary: Bulk Replace description: Replace Entire IP Address List parameters: - name: ip_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/ip_list_ips_bulk_replace_single" multiple: "$ref": "#/components/examples/ip_list_ips_bulk_replace_multiple" required: true responses: '200': description: Replaced IP addresses content: application/json: schema: type: object example: created: true tags: - Ip Lists operationId: ip_lists_ip_list_id_ips_bulk_replace_post "/api/v0/ip_lists/{ip_list_id}/ips/file_bulk_create": post: summary: File Bulk Create description: Add IPs to an Address list from a File parameters: - name: ip_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing IP addresses to append required: true responses: '201': description: Append confirmation content: application/json: schema: type: object example: created: true tags: - Ip Lists operationId: ip_lists_ip_list_id_ips_file_bulk_create_post "/api/v0/ip_lists/{ip_list_id}/ips/file_bulk_delete": delete: summary: File Bulk Delete description: Remove IP Addresses using a File parameters: - name: ip_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing IP addresses to remove responses: '200': description: Deletion confirmation content: application/json: schema: type: object example: deleted: true tags: - Ip Lists operationId: ip_lists_ip_list_id_ips_file_bulk_delete_delete "/api/v0/ip_lists/{ip_list_id}/ips/file_bulk_replace": post: summary: File Bulk Replace description: Replace Entire IP List with File parameters: - name: ip_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing IP addresses to replace existing list required: true responses: '200': description: Replacement confirmation content: application/json: schema: type: object example: created: true tags: - Ip Lists operationId: ip_lists_ip_list_id_ips_file_bulk_replace_post "/api/v0/keys/{key_id}/values/{value_id}": get: summary: Show parameters: - name: key_id in: path required: true schema: type: string - name: value_id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Keys operationId: keys_key_id_values_value_id_get put: summary: Update parameters: - name: key_id in: path required: true schema: type: string - name: value_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: key_value_update_simple: "$ref": "#/components/examples/key_value_update_simple" key_value_update_full: "$ref": "#/components/examples/key_value_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Keys operationId: keys_key_id_values_value_id_put patch: summary: Update parameters: - name: key_id in: path required: true schema: type: string - name: value_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: key_value_update_simple: "$ref": "#/components/examples/key_value_update_simple" key_value_update_full: "$ref": "#/components/examples/key_value_update_full" responses: '200': description: '' content: application/json: schema: type: object tags: - Keys operationId: keys_key_id_values_value_id_patch delete: summary: Destroy parameters: - name: key_id in: path required: true schema: type: string - name: value_id in: path required: true schema: type: string responses: '204': description: No content tags: - Keys operationId: keys_key_id_values_value_id_delete "/api/v0/parameter_lists/{parameter_list_id}/values/bulk_create": post: summary: Bulk Create parameters: - name: parameter_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: parameter_list_values_bulk_single: "$ref": "#/components/examples/parameter_list_values_bulk_single" parameter_list_values_bulk_multiple: "$ref": "#/components/examples/parameter_list_values_bulk_multiple" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Parameter Lists operationId: parameter_lists_parameter_list_id_values_bulk_create_post "/api/v0/parameter_lists/{parameter_list_id}/values/bulk_delete": delete: summary: Bulk Delete parameters: - name: parameter_list_id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Parameter Lists operationId: parameter_lists_parameter_list_id_values_bulk_delete_delete "/api/v0/parameter_lists/{parameter_list_id}/values/bulk_replace": post: summary: Bulk Replace parameters: - name: parameter_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: parameter_list_values_bulk_single: "$ref": "#/components/examples/parameter_list_values_bulk_single" parameter_list_values_bulk_multiple: "$ref": "#/components/examples/parameter_list_values_bulk_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Parameter Lists operationId: parameter_lists_parameter_list_id_values_bulk_replace_post "/api/v0/parameter_lists/{parameter_list_id}/values/file_bulk_create": post: summary: File Bulk Create description: Append parameter list values from a CSV file parameters: - name: parameter_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing key-value pairs to append required: true responses: '201': description: Append confirmation content: application/json: schema: type: object example: created: true tags: - Parameter Lists operationId: parameter_lists_parameter_list_id_values_file_bulk_create_post "/api/v0/parameter_lists/{parameter_list_id}/values/file_bulk_delete": delete: summary: File Bulk Delete description: Remove parameter list values specified in a CSV file parameters: - name: parameter_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing key-value pairs to remove responses: '200': description: Deletion confirmation content: application/json: schema: type: object example: deleted: true tags: - Parameter Lists operationId: parameter_lists_parameter_list_id_values_file_bulk_delete_delete "/api/v0/parameter_lists/{parameter_list_id}/values/file_bulk_replace": post: summary: File Bulk Replace description: Replace all parameter list values with contents of a CSV file parameters: - name: parameter_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing key-value pairs to replace existing list required: true responses: '200': description: Replacement confirmation content: application/json: schema: type: object example: created: true tags: - Parameter Lists operationId: parameter_lists_parameter_list_id_values_file_bulk_replace_post "/api/v0/publisher_id_lists/{publisher_id_list_id}/publisher_ids/bulk_create": post: summary: Bulk Create parameters: - name: publisher_id_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/publisher_id_list_publisher_ids_bulk_create_single" multiple: "$ref": "#/components/examples/publisher_id_list_publisher_ids_bulk_create_multiple" required: true responses: '201': description: '' content: application/json: schema: type: object tags: - Publisher Id Lists operationId: publisher_id_lists_publisher_id_list_id_publisher_ids_bulk_create_post "/api/v0/publisher_id_lists/{publisher_id_list_id}/publisher_ids/bulk_delete": delete: summary: Bulk Delete parameters: - name: publisher_id_list_id in: path required: true schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Publisher Id Lists operationId: publisher_id_lists_publisher_id_list_id_publisher_ids_bulk_delete_delete "/api/v0/publisher_id_lists/{publisher_id_list_id}/publisher_ids/bulk_replace": post: summary: Bulk Replace parameters: - name: publisher_id_list_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: single: "$ref": "#/components/examples/publisher_id_list_publisher_ids_bulk_replace_single" multiple: "$ref": "#/components/examples/publisher_id_list_publisher_ids_bulk_replace_multiple" required: true responses: '200': description: '' content: application/json: schema: type: object tags: - Publisher Id Lists operationId: publisher_id_lists_publisher_id_list_id_publisher_ids_bulk_replace_post "/api/v0/publisher_id_lists/{publisher_id_list_id}/publisher_ids/file_bulk_create": post: summary: File Bulk Create description: Append publisher IDs from a CSV file parameters: - name: publisher_id_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing publisher IDs to append required: true responses: '201': description: Append confirmation content: application/json: schema: type: object tags: - Publisher Id Lists operationId: publisher_id_lists_publisher_id_list_id_publisher_ids_file_bulk_create_post "/api/v0/publisher_id_lists/{publisher_id_list_id}/publisher_ids/file_bulk_delete": delete: summary: File Bulk Delete description: Remove publisher IDs listed in a CSV file parameters: - name: publisher_id_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file listing publisher IDs to remove required: true responses: '200': description: Deletion confirmation content: application/json: schema: type: object tags: - Publisher Id Lists operationId: publisher_id_lists_publisher_id_list_id_publisher_ids_file_bulk_delete_delete "/api/v0/publisher_id_lists/{publisher_id_list_id}/publisher_ids/file_bulk_replace": post: summary: File Bulk Replace description: Replace publisher IDs using a CSV file parameters: - name: publisher_id_list_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing the new publisher ID list required: true responses: '200': description: Replacement confirmation content: application/json: schema: type: object tags: - Publisher Id Lists operationId: publisher_id_lists_publisher_id_list_id_publisher_ids_file_bulk_replace_post "/api/v0/segments/{segment_id}/items/bulk_create": post: summary: Bulk Create description: Add elements to a Segment parameters: - name: segment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: segment_items_bulk_create_single: "$ref": "#/components/examples/segment_items_bulk_create_single" segment_items_bulk_create_multiple: "$ref": "#/components/examples/segment_items_bulk_create_multiple" required: true responses: '201': description: Created items content: application/json: schema: type: object example: created: true tags: - Segments operationId: segments_segment_id_items_bulk_create_post "/api/v0/segments/{segment_id}/items/bulk_delete": delete: summary: Bulk Delete description: Remove specific Device Ids or Cookies parameters: - name: segment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object example: items: - d207654f-6bdd-474e-9734-67b7c3d02d96 responses: '200': description: Deleted items content: application/json: schema: type: object example: deleted: true tags: - Segments operationId: segments_segment_id_items_bulk_delete_delete "/api/v0/segments/{segment_id}/items/bulk_replace": post: summary: Bulk Replace description: Replace Entire Segment parameters: - name: segment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object examples: segment_items_bulk_replace_single: "$ref": "#/components/examples/segment_items_bulk_replace_single" segment_items_bulk_replace_multiple: "$ref": "#/components/examples/segment_items_bulk_replace_multiple" required: true responses: '200': description: Replaced items content: application/json: schema: type: object example: created: true tags: - Segments operationId: segments_segment_id_items_bulk_replace_post "/api/v0/segments/{segment_id}/items/file_bulk_create": post: summary: File Bulk Create description: Add Items to a Segment using a File parameters: - name: segment_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing device IDs or cookies to append required: true responses: '201': description: Append confirmation content: application/json: schema: type: object example: created: true tags: - Segments operationId: segments_segment_id_items_file_bulk_create_post "/api/v0/segments/{segment_id}/items/file_bulk_delete": delete: summary: File Bulk Delete description: Remove specific items using a File parameters: - name: segment_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing device IDs or cookies to remove responses: '200': description: Deletion confirmation content: application/json: schema: type: object example: deleted: true tags: - Segments operationId: segments_segment_id_items_file_bulk_delete_delete "/api/v0/segments/{segment_id}/items/file_bulk_replace": post: summary: File Bulk Replace description: Replace Entire Segment with a File parameters: - name: segment_id in: path required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object required: - csv_file properties: csv_file: type: string format: binary description: CSV file containing device IDs or cookies to replace existing segment required: true responses: '200': description: Replacement confirmation content: application/json: schema: type: object example: created: true tags: - Segments operationId: segments_segment_id_items_file_bulk_replace_post components: examples: video_creative_create_simple: summary: Simple value: name: Video Creative Name demand_partner_id: 1 creative_remote_url: https://example.com/video.mp4 video_creative_create_full: summary: Full value: name: Video Creative Name demand_partner_id: 1 creative_remote_url: https://example.com/video.mp4 creative_landing_page_url: https://example.com/landing code: video-code secondary_code: video-secondary advertiser_domain: example.com iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_source: list country_list_ids: - 1 state_source: list state_list_ids: - 1 city_source: list city_list_ids: - 1 metro_area_source: list metro_area_list_ids: - 1 postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image active: true video_creative_update_simple: summary: Simple value: name: Video Creative Name active: true video_creative_update_full: summary: Full value: name: Video Creative Name creative_landing_page_url: https://example.com/landing code: video-code secondary_code: video-secondary advertiser_domain: example.com iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_source: list country_list_ids: - 1 state_source: list state_list_ids: - 1 city_source: list city_list_ids: - 1 metro_area_source: list metro_area_list_ids: - 1 postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image active: true value_list_create_simple: summary: Simple value: name: Value List Name key_id: 1 value_list_create_full: summary: Full value: name: Value List Name key_id: 1 description: Value list description free_values: - value-one - value-two value_ids: - 1 - 2 value_list_update_simple: summary: Simple value: name: Value List Name value_list_update_full: summary: Full value: name: Value List Name description: Value list description free_values: - value-one - value-two value_ids: - 1 - 2 tile_creative_clickable_image_create_simple: summary: Clickable Image Simple value: name: Tile Creative Name demand_partner_id: 1 creative_remote_url: https://www.example.com/image.jpg creative_landing_page_url: https://www.example.com tile_creative_clickable_image_create_full: summary: Clickable Image Full value: name: Tile Creative Name demand_partner_id: 1 creative_remote_url: https://www.example.com/image.jpg creative_landing_page_url: https://www.example.com code: tile-code secondary_code: tile-secondary overlay_text: Click here line_item_demand_tag_ids: - 1 iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp country_list_ids: - 1 country_source: list country_white_list: true state_list_ids: - 1 state_source: list city_list_ids: - 1 city_source: list metro_area_list_ids: - 1 metro_area_source: list postal_code_list_ids: - 1 postal_code_source: list key_value_targeting: true budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York active: true tile_creative_custom_create_simple: summary: Custom Simple value: name: Tile Creative Name demand_partner_id: 1 custom: true custom_code: "
Ad
" width: 1 height: 1 tile_creative_custom_create_full: summary: Custom Full value: name: Tile Creative Name demand_partner_id: 1 custom: true custom_code: "
Ad
" width: 1 height: 1 creative_landing_page_url: https://www.example.com code: tile-code secondary_code: tile-secondary overlay_text: Click here line_item_demand_tag_ids: - 1 iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp country_list_ids: - 1 country_source: list state_list_ids: - 1 state_source: list city_list_ids: - 1 city_source: list metro_area_list_ids: - 1 metro_area_source: list postal_code_list_ids: - 1 postal_code_source: list key_value_targeting: true budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York active: true tile_creative_update_simple: summary: Simple value: name: Tile Creative Name creative_landing_page_url: https://www.example.com active: true tile_creative_update_full: summary: Full value: name: Tile Creative Name creative_remote_url: https://www.example.com/image.jpg creative_landing_page_url: https://www.example.com overlay_text: Click here code: tile-code secondary_code: tile-secondary line_item_demand_tag_ids: - 1 iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp country_list_ids: - 1 country_source: list state_list_ids: - 1 state_source: list city_list_ids: - 1 city_source: list metro_area_list_ids: - 1 metro_area_source: list postal_code_list_ids: - 1 postal_code_source: list key_value_targeting: true budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York active: true tag_creative_create_simple: summary: Simple value: name: Tag Creative Name demand_partner_id: 1 vast_endpoint_url: https://staging-tv.springserve.com/vast tag_creative_create_full: summary: Full value: name: Tag Creative Name demand_partner_id: 1 vast_endpoint_url: https://staging-tv.springserve.com/vast creative_landing_page_url: https://ad.example.com/landing advertiser_domain: example.com code: tag-code secondary_code: tag-secondary line_item_demand_tag_ids: - 1 iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp country_list_ids: - 1 country_source: list country_white_list: true state_list_ids: - 1 state_source: list city_list_ids: - 1 city_source: list metro_area_list_ids: - 1 metro_area_source: list postal_code_list_ids: - 1 postal_code_source: list key_value_targeting: true budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York active: true tag_creative_update_simple: summary: Simple value: name: Tag Creative Name vast_endpoint_url: https://staging-tv.springserve.com/vast active: true tag_creative_update_full: summary: Full value: name: Tag Creative Name vast_endpoint_url: https://staging-tv.springserve.com/vast creative_landing_page_url: https://ad.example.com/landing advertiser_domain: example.com code: tag-code secondary_code: tag-secondary line_item_demand_tag_ids: - 1 iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp country_list_ids: - 1 country_source: list state_list_ids: - 1 state_source: list city_list_ids: - 1 city_source: list metro_area_list_ids: - 1 metro_area_source: list postal_code_list_ids: - 1 postal_code_source: list key_value_targeting: true budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York active: true supply_tag_tag_create_simple: summary: Tag Simple value: name: Supply Tag Name supply_partner_id: 1 supply_class: 1 rate: 1.11 supply_tag_tag_create_full: summary: Tag Full value: name: Supply Tag Name supply_partner_id: 1 supply_class: 1 supply_type: Instream format: video environment: desktop js_vpaid_enabled: false vpaid_none_allow_vpaid_demand: true allowed_player_sizes: - s - m - l player_size_targeting: Custom min_aspect_ratio: '16:9' max_aspect_ratio: '16:9' domain_targeting: Allowlist domain_list_ids: - 1 app_name_targeting: Allowlist app_name_list_ids: - 1 app_bundle_targeting: Allowlist app_bundle_list_ids: - 1 ip_targeting: Allowlist ip_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 state_targeting: Include state_source: list state_list_ids: - 1 city_targeting: Include city_source: list city_list_ids: - 1 metro_area_targeting: Include metro_area_source: list metro_area_list_ids: - 1 postal_code_targeting: Include postal_code_source: list postal_code_list_ids: - 1 advertiser_domain_targeting: Allowlist advertiser_domain_list_ids: - 1 blocking_unknown_advertiser_domains: true ignore_advertiser_domain_targeting: false ignore_iab_targeting: false targeted_iab_category_white_list: true targeted_iab_category_source: list iab_category_tier1_list_ids: - 1 targeted_iab_tier2_category_white_list: true targeted_iab_tier2_category_source: list iab_category_tier2_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true targeted_macros_enabled: true creative_political_ads: - '1' audited_creative_statuses: - approved scanned_creative_white_list: true scanned_creative_list_ids: - 1 obfuscate_ip_address_enabled: false obfuscate_latlon_enabled: false obf_ip_flags: - dnt pre_bid_blocking_enabled: false post_imp_detection_enabled: false post_imp_percentage_whiteops: 1 post_imp_percentage_ias: 1 post_imp_percentage_moat: 1 omsdk_enabled: false rate: 1.11 rate_currency: USD payment_terms: CPM rpm_floor: 1.11 rpm_floor_openrtb: false rpm_floor_hb: false openrtb_floor: 1.11 open_market_enabled: false auto_add_external_bidders: false waterfall_management: demand_tag supply_allocation: false allow_traffic_exclusions: false allow_duplicate_creatives: true allow_duplicate_adomains: true tier_breakout_enabled: false timeout: 1 override_inbound_tmax: false budget_timezone: America/New_York budgets: - budget_period: daily budget_metric: spend budget_value: 1.11 budget_pacing: smooth frequency_caps: - imps: 1 duration: 1 duration_unit: days demand_tag_priorities: - demand_tag_id: 1 priority: 1 tier: 1 ratio: 1 give_up_percents: - ss_object_id: 1 ss_object_type: DemandTag percent: 1 macro_overrides: - override_type: static macro_param: "{{IP}}" override_value: '1' advanced_floor_rules: - dimension: adomain values: - example.com floor_price: 1.11 supply_label_ids: - 1 key_ids: - 1 creative_allow_objectionable: false creative_brandsafe_override: false vast_version: 3.0 bulk_add_enabled: true evaluation_learn_pct: 1.11 player_fee: false skip_enabled: false code: supply-tag-code active: true supply_tag_bid_link_create_simple: summary: BidLink Simple value: name: Supply Tag Name supply_partner_id: 1 supply_class: 3 rate: 1.11 supply_tag_bid_link_create_full: summary: BidLink Full value: name: Supply Tag Name supply_partner_id: 1 supply_class: 3 format: video environment: desktop allowed_player_sizes: - s - m - l player_size_targeting: Custom domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true rate: 1.11 rate_currency: USD payment_terms: CPM rpm_floor: 1.11 openrtb_floor: 1.11 open_market_enabled: false waterfall_management: demand_tag budget_timezone: America/New_York budgets: - budget_period: daily budget_metric: spend budget_value: 1.11 budget_pacing: smooth rtb_version_targeting_enabled: true rtb_version: '2.5' ignore_max_sequence: true max_sequence_override: 1 bid_return_net_price: false vast_ext_return_net_price: false code: supply-tag-code active: true supply_tag_tile_create_simple: summary: Tile Simple value: name: Supply Tag Name supply_partner_id: 1 supply_class: 1 format: tile dynamic_tile: false width: 1 height: 1 rate: 1.11 supply_tag_tile_create_full: summary: Tile Full value: name: Supply Tag Name supply_partner_id: 1 supply_class: 1 format: tile environment: desktop dynamic_tile: false width: 1 height: 1 screen_setting: in_content domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true rate: 1.11 rate_currency: USD payment_terms: CPM rpm_floor: 1.11 budget_timezone: America/New_York budgets: - budget_period: daily budget_metric: spend budget_value: 1.11 budget_pacing: smooth supply_label_ids: - 1 code: supply-tag-code active: true supply_tag_audio_create_simple: summary: Audio Simple value: name: Supply Tag Name supply_partner_id: 1 supply_class: 1 format: audio rate: 1.11 supply_tag_audio_create_full: summary: Audio Full value: name: Supply Tag Name supply_partner_id: 1 supply_class: 1 format: audio environment: desktop domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true rate: 1.11 rate_currency: USD payment_terms: CPM rpm_floor: 1.11 budget_timezone: America/New_York budgets: - budget_period: daily budget_metric: spend budget_value: 1.11 budget_pacing: smooth supply_label_ids: - 1 code: supply-tag-code active: true supply_tag_pause_ad_create_simple: summary: Pause Ad Simple value: name: Supply Tag Name supply_partner_id: 1 supply_class: 1 format: pause_ad rate: 1.11 supply_tag_pause_ad_create_full: summary: Pause Ad Full value: name: Supply Tag Name supply_partner_id: 1 supply_class: 1 format: pause_ad environment: desktop screen_setting: in_content domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true rate: 1.11 rate_currency: USD payment_terms: CPM rpm_floor: 1.11 budget_timezone: America/New_York budgets: - budget_period: daily budget_metric: spend budget_value: 1.11 budget_pacing: smooth supply_label_ids: - 1 code: supply-tag-code active: true supply_tag_update_simple: summary: Simple value: rate: 1.11 active: true supply_tag_update_full: summary: Full value: name: Supply Tag Name rate: 1.11 rate_currency: USD payment_terms: CPM rpm_floor: 1.11 rpm_floor_hb: false open_market_enabled: false format: video environment: desktop domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true timeout: 1 budget_timezone: America/New_York budgets: - budget_period: daily budget_metric: spend budget_value: 1.11 budget_pacing: smooth frequency_caps: - imps: 1 duration: 1 duration_unit: days demand_tag_priorities: - demand_tag_id: 1 priority: 1 tier: 1 ratio: 1 macro_overrides: - override_type: static macro_param: "{{IP}}" override_value: '1' advanced_floor_rules: - dimension: adomain values: - example.com floor_price: 1.11 supply_label_ids: - 1 key_ids: - 1 code: supply-tag-code active: true supply_router_create_simple: summary: Simple value: name: Supply Router Name supply_partner_id: 1 supply_router_create_full: summary: Full value: name: Supply Router Name supply_partner_id: 1 code: '1' environment: desktop format: video supply_router_ratios: - supply_tag_id: 1 fallback_supply_tag_id: 1 ratio: 1 key_ids: - 1 all_player_sizes: false player_sizes: - s - m - l min_aspect_ratio: 1.11 max_aspect_ratio: 1.11 domain_white_list: true domain_list_ids: - 1 advertiser_domain_white_list: true advertiser_domain_list_ids: - 1 blocking_unknown_advertiser_domains: true targeted_iab_category_white_list: true targeted_iab_tier2_category_white_list: true targeted_iab_category_source: list targeted_iab_tier2_category_source: list targeted_iab_category_codes: - IAB1 targeted_iab_tier2_category_codes: - IAB1-1 iab_category_tier1_list_ids: - 1 iab_category_tier2_list_ids: - 1 app_name_white_list: true app_name_list_ids: - 1 app_bundle_white_list: true app_bundle_list_ids: - 1 ip_white_list: true ip_list_ids: - 1 country_source: list country_white_list: true country_codes: - US country_list_ids: - 1 metro_area_source: list metro_area_white_list: true metro_area_codes: - 2001 metro_area_list_ids: - 1 user_agent_devices: - '1' user_agent_brands: - '1' user_agent_operating_systems: - '1' user_agent_browsers: - '1' segment_targeting_enabled: true segment_groups: - group: 1 white_list: true segment_ids: - 1 coppa_values: - '1' coppa_param_required: true dnt_values: - '1' dnt_param_required: true lmt_values: - '1' lmt_param_required: true us_privacy_values: - '1' us_privacy_param_required: true us_privacy_supply_white_list: true gdpr_supply_values: - '1' gdpr_supply_param_required: true gdpr_consent_string_values: - '1' gdpr_consent_param_required: true start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: household audited_creative_statuses: - '1' scanned_creative_white_list: true scanned_creative_list_ids: - 1 third_party_override: true post_imp_detection_enabled: true post_imp_percentage_whiteops: 1 post_imp_percentage_ias: 1 post_imp_percentage_moat: 1 post_imp_percentage_protected: 1 post_imp_percentage_forensiq: 1 pre_bid_blocking_enabled: true pre_bid_blocking_components: - '1' tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://ad.example.com/pixel custom_response: '1' active: true note: Supply Router note supply_router_update_simple: summary: Simple value: name: Supply Router Name active: true supply_router_update_full: summary: Full value: name: Supply Router Name supply_partner_id: 1 code: '1' environment: desktop format: video supply_router_ratios: - supply_tag_id: 1 fallback_supply_tag_id: 1 ratio: 1 player_sizes: - s - m - l domain_white_list: true domain_list_ids: - 1 country_source: list country_white_list: true country_codes: - US country_list_ids: - 1 segment_targeting_enabled: true segment_groups: - group: 1 white_list: true segment_ids: - 1 start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York third_party_override: true post_imp_detection_enabled: true custom_response: '1' active: true note: Supply Router note supply_partner_create_simple: summary: Simple value: name: Supply Partner Name optimization_active_default: true supply_partner_create_full: summary: Full value: name: Supply Partner Name optimization_active_default: true optimization_custom_defaults: false optimization_settings_default: metric: Request Fill lookback_minutes: '30' default_open_market_tier: 1 supply_allocation_default: 1 tiles_response_type: default code: '1' fire_nurl_upstream_enabled: false wrap_tracking_pixels: false ssb_return_bid_price: false iris_tv_active: false nielsen_dar_active: false tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp audited_creative_statuses: [] targeting_geo_profile: country_white_list: true country_source: list country_list_ids: - 1 targeting_page_attribute_profile: domain_white_list: true domain_list_ids: - 1 segment_targeting_enabled: false supply_partner_update_simple: summary: Simple value: name: Supply Partner Name supply_partner_update_full: summary: Full value: name: Supply Partner Name optimization_active_default: true optimization_custom_defaults: false optimization_settings_default: metric: Request Fill lookback_minutes: '30' default_open_market_tier: 1 tiles_response_type: default fire_nurl_upstream_enabled: false wrap_tracking_pixels: false ssb_return_bid_price: false tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp audited_creative_statuses: [] targeting_geo_profile: country_white_list: true country_source: list country_list_ids: - 1 targeting_page_attribute_profile: domain_white_list: true domain_list_ids: - 1 segment_targeting_enabled: false supply_label_create_simple: summary: Simple value: name: Supply Label Name supply_label_create_full: summary: Full value: name: Supply Label Name supply_tag_ids: - 1 supply_label_update_simple: summary: Simple value: name: Supply Label Name supply_label_update_full: summary: Full value: name: Supply Label Name supply_tag_ids: - 1 state_list_create_simple: summary: Simple value: name: State List Name state_codes: - US-CA - US-NY state_list_create_full: summary: Full value: name: State List Name description: State List Description active: true state_codes: - US-CA - US-NY state_list_update_simple: summary: Simple value: name: State List Name state_list_update_full: summary: Full value: name: State List Name description: State List Description active: true state_codes: - CA-ON - GB-ENG selling_strategy_update_simple: summary: Simple value: name: Connected Demand Name active: true selling_strategy_update_full: summary: Full value: name: Connected Demand Name active: true deal_id: DEAL_001 openrtb_auction_type: 3 vast_endpoint_url: https://ad.example.com/vast.xml demand_code: '1' secondary_code: '1' domain_targeting: true domain_list_ids: - 1 app_name_targeting: true app_name_list_ids: - 1 app_bundle_targeting: true app_bundle_list_ids: - 1 ip_targeting: true ip_list_ids: - 1 country_targeting: true country_source: list country_list_ids: - 1 state_targeting: true state_source: list state_list_ids: - 1 city_targeting: true city_source: list city_list_ids: - 1 metro_area_targeting: true metro_area_source: list metro_area_list_ids: - 1 postal_code_targeting: true postal_code_source: list postal_code_list_ids: - 1 allowed_player_sizes: - s - m - l key_value_targeting: false segment_targeting_enabled: false competitive_exclusions_enabled: false competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 targeted_macros_enabled: false respect_pod_order: false share_of_voice_goal_percent: 1 booked_revenue: 1.11 floor_rate: 1.11 floor_rate_currency: USD budget_timezone: America/New_York device_id_required: false post_imp_detection_enabled: false realtime_viewability: false demand_label_ids: - 1 supply_tag_assignments: - supply_tag_id: 1 allocation: 1 demand_tag_priorities: - supply_tag_id: 1 priority: 1 tier: 1 ratio: 1 start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York forward_deal_ids_enabled: false bypass_private_auction_flag_enabled: false share_eids_enabled: false isp_source: list isp_list_ids: - 1 segment_list_create_simple: summary: List segment (simple) value: name: Segment Name segment_type: list segment_list_type: cookie segment_list_create_full: summary: List segment (full) value: name: Segment Name description: Segment description segment_type: list segment_list_type: cookie active: true segment_pixel_create_simple: summary: Pixel segment (simple) value: name: Segment Name segment_type: pixel segment_pixel_type: device_id user_expiration_value: 30 segment_pixel_create_full: summary: Pixel segment (full) value: name: Segment Name description: Segment description segment_type: pixel segment_pixel_type: device_id user_expiration_value: 30 active: true segment_update_simple: summary: Update segment (simple) value: name: Segment Name active: true segment_update_full: summary: Update segment (full) value: name: Segment Name description: Segment description active: true segment_items_bulk_create_single: summary: Add single item value: items: - d207654f-6bdd-474e-9734-67b7c3d02d96 segment_items_bulk_create_multiple: summary: Add multiple items value: items: - d207654f-6bdd-474e-9734-67b7c3d02d96 - a1b2c3d4-6bdd-474e-9734-67b7c3d02d96 segment_items_bulk_replace_single: summary: Replace with single item value: items: - d207654f-6bdd-474e-9734-67b7c3d02d96 segment_items_bulk_replace_multiple: summary: Replace with multiple items value: items: - d207654f-6bdd-474e-9734-67b7c3d02d96 - a1b2c3d4-6bdd-474e-9734-67b7c3d02d96 report_create_simple: summary: Simple value: date_range: Yesterday dimensions: - supply_tag_id metrics: - impressions - revenue report_create_full: summary: Full value: async: true currency: USD date_range: Yesterday interval: cumulative timezone: UTC dimensions: - supply_tag_id - demand_tag_id metrics: - impressions - revenue - fill_rate - cpm publisher_id_list_create_simple: summary: Simple value: name: Publisher ID List Name publisher_id_list_create_full: summary: Full value: name: Publisher ID List Name description: Publisher ID list description active: true publisher_id_list_update_simple: summary: Simple value: name: Publisher ID List Name publisher_id_list_update_full: summary: Full value: name: Publisher ID List Name description: Publisher ID list description active: true publisher_id_list_publisher_ids_bulk_create_single: summary: Single value: publisher_ids: - pub-abc-123 publisher_id_list_publisher_ids_bulk_create_multiple: summary: Multiple value: publisher_ids: - pub-abc-123 - pub-xyz-456 - pub-def-789 publisher_id_list_publisher_ids_bulk_replace_single: summary: Single value: publisher_ids: - pub-abc-123 publisher_id_list_publisher_ids_bulk_replace_multiple: summary: Multiple value: publisher_ids: - pub-abc-123 - pub-xyz-456 - pub-def-789 programmatic_guaranteed_create_simple: summary: Simple value: name: Programmatic Guaranteed Name demand_class: 11 demand_partner_id: 1 rate: 1.11 inventory_groups: - group: 1 list_type: white_list source_type: values inventory_object: DealList inventory_values: - 1 programmatic_guaranteed_create_full: summary: Full value: name: Programmatic Guaranteed Name demand_class: 11 demand_partner_id: 1 campaign_id: 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 code: '1' secondary_code: '1' vast_endpoint_url: https://staging-tv.springserve.com/vast inventory_groups: - group: 1 list_type: white_list source_type: values inventory_object: DealList inventory_values: - 1 deal_list_ids: - 1 line_item_ratios: - creative_id: 1 ratio: 1 demand_label_ids: - 1 tag_pixels_attributes: - pixel_url: https://ad.example.com/pixel pixel_type: AdImpression pixel_format: image custom_vast_extensions_attributes: - custom_key: '1' custom_value: '1' frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: household budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York post_imp_detection_enabled: true post_imp_percentage_whiteops: 1 post_imp_percentage_ias: 1 post_imp_percentage_moat: 1 post_imp_percentage_protected: 1 post_imp_percentage_forensiq: 1 mediaocean_prisma_enabled: true mediaocean_prisma_order_id: '1' mediaocean_prisma_campaign_id: '1' mediaocean_prisma_placement_id: '1' mediaocean_prisma_campaign_link: https://prisma.example.com/campaign active: true note: Programmatic Guaranteed note programmatic_guaranteed_update_simple: summary: Simple value: name: Programmatic Guaranteed Name rate: 1.11 active: true programmatic_guaranteed_update_full: summary: Full value: name: Programmatic Guaranteed Name campaign_id: 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 secondary_code: '1' vast_endpoint_url: https://staging-tv.springserve.com/vast line_item_ratios: - creative_id: 1 ratio: 1 demand_label_ids: - 1 budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York post_imp_detection_enabled: true active: true note: Programmatic Guaranteed note postal_code_list_create_simple: summary: Simple value: name: Postal Code List Name postal_codes: - '10001' postal_code_list_create_full: summary: Full value: name: Postal Code List Name description: Postal Code List Description postal_codes: - '10001' active: true postal_code_list_update_simple: summary: Simple value: name: Postal Code List Name postal_code_list_update_full: summary: Full value: name: Postal Code List Name description: Postal Code List Description active: true postal_codes: - '10001' partner_segment_update_simple: summary: Simple value: active: true partner_segment_update_full: summary: Full value: active: false partner_segment_bulk_create_single: summary: Single value: partner_segments: - code: EXAMPLE_PARTNER_SEGMENT_1 vendor_id: 1 description: Example Partner Segment cpm: 1.11 partner_segment_bulk_create_multiple: summary: Multiple value: partner_segments: - code: EXAMPLE_PARTNER_SEGMENT_1 vendor_id: 1 description: Example Partner Segment cpm: 1.11 external_code: '' dmp_segment_id: 1 category: EXAMPLE_CATEGORY political: false adv_id: 1 enabled: true - code: EXAMPLE_PARTNER_SEGMENT_2 vendor_id: 1 description: Another Partner Segment cpm: 1.11 external_code: '' dmp_segment_id: 1 category: EXAMPLE_CATEGORY political: false adv_id: 1 enabled: false parameter_list_create_simple: summary: Simple value: name: Parameter List Name macro_param: "{{CONTENT_ID}}" parameter_list_create_full: summary: Full value: name: Parameter List Name macro_param: "{{CONTENT_ID}}" description: Parameter list description active: true parameter_list_update_simple: summary: Simple value: name: Parameter List Name parameter_list_update_full: summary: Full value: name: Parameter List Name description: Updated description active: true parameter_list_values_bulk_single: summary: Single value: values: - value_one parameter_list_values_bulk_multiple: summary: Multiple value: values: - value_one - value_two - value_three operative_advertiser_create_simple: summary: Simple value: sourceAdvertiserId: '1' name: Operative Advertiser Name operative_advertiser_create_full: summary: Full value: sourceAdvertiserId: '1' name: Operative Advertiser Name operative_order_create_simple: summary: Simple value: sourceOrderId: '1' name: Operative Order Name advertiserId: '1' 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_order_update_simple: summary: Simple value: orderId: '1' lineitems: - lineitemId: '1' name: Operative Line Item 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 metro_area_list_create_simple: summary: Simple value: name: Metro Area List Name metro_area_codes: - 2001 metro_area_list_create_full: summary: Full value: name: Metro Area List Name description: Metro Area List Description metro_area_codes: - 2001 active: true metro_area_list_update_simple: summary: Simple value: name: Metro Area List Name metro_area_list_update_full: summary: Full value: name: Metro Area List Name description: Metro Area List Description active: true metro_area_codes: - 2001 key_create_simple: summary: Simple value: name: Key Name key: my-custom-key definition_type: free key_create_full: summary: Full value: name: Key Name key: my-custom-key definition_type: predefined description: Key description log_level_reporting_only: false supply_client_reporting_enabled: true demand_client_reporting_enabled: true key_sharing_enabled: false key_update_simple: summary: Simple value: name: Key Name key_update_full: summary: Full value: name: Key Name description: Updated key description log_level_reporting_only: false supply_client_reporting_enabled: true demand_client_reporting_enabled: true key_sharing_enabled: true key_sharing_other_account_ids: - 1 key_value_create_simple: summary: Simple value: name: Key Name value: my-value key_value_create_full: summary: Full value: name: Key Name value: my-value key_value_update_simple: summary: Simple value: name: Key Name key_value_update_full: summary: Full value: name: Key Name value: updated-value ip_list_create_simple: summary: Simple value: name: IP List Name ip_list_create_full: summary: Full value: name: IP List Name description: IP list description active: true ip_list_update_simple: summary: Simple value: name: IP List Name ip_list_update_full: summary: Full value: name: IP List Name description: IP list description active: true ip_list_ips_bulk_create_single: summary: Single value: ips: - 158.106.194.74 ip_list_ips_bulk_create_multiple: summary: Multiple value: ips: - 158.106.194.74 - 158.106.194.75 - 10.0.0.1 ip_list_ips_bulk_replace_single: summary: Single value: ips: - 1.1.11.1 ip_list_ips_bulk_replace_multiple: summary: Multiple value: ips: - 1.1.11.1 - 1.0.11.1 - 192.168.1.1 hb_bid_map_create_simple: summary: Simple value: name: HB Bid Map Name bid_platform: amazon hb_bid_map_type: inventory_split hb_bid_map_create_full: summary: Full value: name: HB Bid Map Name bid_platform: amazon hb_bid_map_type: paid description: HB Bid Map description hb_bid_map_entries: - parameter_value: ott1_4033_30 bid_floor: 1.11 - parameter_value: ott2_4034_60 bid_floor: 2.22 hb_bid_map_update_simple: summary: Simple value: name: HB Bid Map Name hb_bid_map_update_full: summary: Full value: name: HB Bid Map Name description: Updated description hb_bid_map_entries: - parameter_value: ott3_4035_30 bid_floor: 1.11 bid_map_create_simple: summary: Simple value: name: Bid Map Name bid_platform: amazon hb_bid_map_type: inventory_split bid_map_create_full: summary: Full value: name: Bid Map Name bid_platform: amazon hb_bid_map_type: paid description: Bid Map description hb_bid_map_entries: - parameter_value: ott1_4033_30 bid_floor: 1.11 - parameter_value: ott2_4034_60 bid_floor: 2.22 bid_map_update_simple: summary: Simple value: name: Bid Map Name bid_map_update_full: summary: Full value: name: Bid Map Name description: Updated description hb_bid_map_entries: - parameter_value: ott3_4035_30 bid_floor: 1.11 global_fcap_pixel_create_simple: summary: Simple value: name: Global Fcap Pixel Name frequency_cap_period_amount: 1 frequency_cap_period: hour list_type: ip_address global_fcap_pixel_create_full: summary: Full value: name: Global Fcap Pixel Name description: Global Fcap Pixel Description active: true list_type: ip_address frequency_cap_period_amount: 1 frequency_cap_period: hour global_fcap_pixel_update_simple: summary: Simple value: name: Global Fcap Pixel Name active: true global_fcap_pixel_update_full: summary: Full value: name: Global Fcap Pixel Name description: Global Fcap Pixel Description active: true first_party_partner_segment_bulk_create_single: summary: Bulk create — single item value: first_party_partner_segments: - code: SEG-001 vendor_id: 1 category: automotive dmp_segment_id: 1 description: First party segment cpm: 1.11 political: false adv_id: 1 enabled: true account_ids: - 1 first_party_partner_segment_bulk_create_multiple: summary: Bulk create — multiple items value: first_party_partner_segments: - code: SEG-001 vendor_id: 1 category: automotive dmp_segment_id: 1 description: First party segment cpm: 1.11 political: false adv_id: 1 enabled: true account_ids: - 1 - code: SEG-002 vendor_id: 1 category: sports dmp_segment_id: 1 description: Second first party segment cpm: 1.11 political: false adv_id: 1 enabled: false account_ids: [] domain_list_create_simple: summary: Simple value: name: Domain List Name domain_list_create_full: summary: Full value: name: Domain List Name description: Domain List Description active: true domain_list_update_simple: summary: Simple value: name: Domain List Name domain_list_update_full: summary: Full value: name: Domain List Name description: Domain List Description active: true domain_list_domains_bulk_create_single: summary: Single value: names: - example.com domain_list_domains_bulk_create_multiple: summary: Multiple value: names: - cnn.com - abc.com domain_list_domains_bulk_replace_single: summary: Single value: names: - replacement.com domain_list_domains_bulk_replace_multiple: summary: Multiple value: names: - replacement1.com - replacement2.com demand_tag_tag_create_simple: summary: Tag Simple value: name: Demand Tag Name demand_class: 1 demand_partner_id: 1 allowed_player_sizes: - s - m - l vast_endpoint_url: https://staging-tv.springserve.com/vast rate: 1.11 demand_tag_tag_create_full: summary: Tag Full value: name: Demand Tag Name demand_class: 1 demand_partner_id: 1 campaign_id: 1 allowed_player_sizes: - s - m - l format: video environment: desktop secondary_code: secondary vast_endpoint_url: https://staging-tv.springserve.com/vast timeout: 1 cost_model_type: 0 multi_call_enabled: false multi_call_maximum: 1 domain_targeting: Allowlist domain_list_ids: - 1 app_name_targeting: Allowlist app_name_list_ids: - 1 app_bundle_targeting: Allowlist app_bundle_list_ids: - 1 ip_targeting: Allowlist ip_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 state_targeting: Include state_source: list state_list_ids: - 1 city_targeting: Include city_source: list city_list_ids: - 1 metro_area_targeting: Include metro_area_source: list metro_area_list_ids: - 1 postal_code_targeting: Include postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true targeted_macros_enabled: true advertiser_domain_white_list: true advertiser_domain_list_ids: - 1 blocking_unknown_advertiser_domains: true competitive_exclusions_enabled: true competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 demand_label_ids: - 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 budget_timezone: America/New_York share_of_voice_goal_percent: 1 day_parting_users_timezone: true pre_bid_blocking_enabled: true post_imp_detection_enabled: true post_imp_percentage_whiteops: 1 post_imp_percentage_ias: 1 post_imp_percentage_moat: 1 realtime_viewability: true respect_pod_order: true daa_ad_choices: true device_id_required: true skip_enabled: true skip_offset: 1 suppress_xff_ip: true active: true note: Demand Tag note demand_tag_bidder_create_simple: summary: Bidder Simple value: name: Demand Tag Name demand_class: 3 demand_partner_id: 1 allowed_player_sizes: - s - m - l bid_platform: magnite bid_floor_type: static rate: 1.11 demand_tag_bidder_create_full: summary: Bidder Full value: name: Demand Tag Name demand_class: 3 demand_partner_id: 1 allowed_player_sizes: - s - m - l format: video environment: desktop bid_platform: magnite bid_params: seat_id: '1' bid_floor_type: static bid_margin: 1.11 allow_tier_breakout: false breakout_bid: 1.11 override_supply_floor: false partner_tier_override_enabled: true partner_tier_override: '1' multi_call_enabled: false multi_call_maximum: 1 domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true competitive_exclusions_enabled: true competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 demand_label_ids: - 1 rate: 1.11 rate_currency: USD budget_timezone: America/New_York pre_bid_blocking_enabled: true post_imp_detection_enabled: true realtime_viewability: true daa_ad_choices: true device_id_required: true active: true note: Demand Tag note demand_tag_line_item_create_simple: summary: Line Item Simple value: name: Demand Tag Name demand_class: 11 demand_partner_id: 1 campaign_id: 1 allowed_player_sizes: - s - m - l rate: 1.11 demand_tag_line_item_create_full: summary: Line Item Full value: name: Demand Tag Name demand_class: 11 demand_partner_id: 1 campaign_id: 1 creative_id: 1 allowed_player_sizes: - s - m - l format: video environment: desktop line_item_ratios: - creative_id: 1 ratio: 1 domain_targeting: Allowlist domain_list_ids: - 1 app_name_targeting: Allowlist app_name_list_ids: - 1 app_bundle_targeting: Allowlist app_bundle_list_ids: - 1 ip_targeting: Allowlist ip_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 state_targeting: Include state_source: list state_list_ids: - 1 city_targeting: Include city_source: list city_list_ids: - 1 metro_area_targeting: Include metro_area_source: list metro_area_list_ids: - 1 postal_code_targeting: Include postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true targeted_macros_enabled: true competitive_exclusions_enabled: true competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 demand_label_ids: - 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 cost_model_type: 0 budget_timezone: America/New_York share_of_voice_goal_percent: 1 guaranteed_delivery: false guaranteed_tier: '1' start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York price_extension_enabled: false daa_ad_choices: true device_id_required: true is_reserved: false active: true note: Demand Tag note demand_tag_house_ad_create_simple: summary: House Ad Simple value: name: Demand Tag Name demand_class: 8 demand_partner_id: 1 creative_id: 1 creative_landing_page_url: https://ad.example.com/landing allowed_player_sizes: - s - m - l demand_tag_house_ad_create_full: summary: House Ad Full value: name: Demand Tag Name demand_class: 8 demand_partner_id: 1 creative_id: 1 creative_landing_page_url: https://ad.example.com/landing allowed_player_sizes: - s - m - l format: video environment: desktop domain_targeting: Allowlist domain_list_ids: - 1 app_name_targeting: Allowlist app_name_list_ids: - 1 app_bundle_targeting: Allowlist app_bundle_list_ids: - 1 ip_targeting: Allowlist ip_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 state_targeting: Include state_source: list state_list_ids: - 1 city_targeting: Include city_source: list city_list_ids: - 1 metro_area_targeting: Include metro_area_source: list metro_area_list_ids: - 1 postal_code_targeting: Include postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true targeted_macros_enabled: true competitive_exclusions_enabled: true competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 demand_label_ids: - 1 budget_timezone: America/New_York daa_ad_choices: true device_id_required: true active: true note: Demand Tag note demand_tag_dsp_sub_line_item_create_simple: summary: DSP Sub Line Item Simple value: name: Demand Tag Name demand_class: 11 demand_partner_id: 1 campaign_id: 1 allowed_player_sizes: - s - m - l bid_floor_type: static buying_model: private_market rate: 1.11 demand_tag_dsp_sub_line_item_create_full: summary: DSP Sub Line Item Full value: name: Demand Tag Name demand_class: 11 demand_partner_id: 1 campaign_id: 1 allowed_player_sizes: - s - m - l format: video environment: desktop buying_model: private_market bid_floor_type: static bid_margin: 1.11 campaign_tier: 1 domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 isp_source: list isp_list_ids: - 1 isp_names: - '1' key_value_targeting: true segment_targeting_enabled: true competitive_exclusions_enabled: true competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 demand_label_ids: - 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 cost_model_type: 0 budget_timezone: America/New_York guaranteed_delivery: false start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York daa_ad_choices: true device_id_required: true is_reserved: false active: true note: Demand Tag note demand_tag_marketplace_deal_create_simple: summary: Marketplace Deal Simple value: name: Demand Tag Name demand_class: 12 demand_partner_id: 1 allowed_player_sizes: - s - m - l curator_fee_type: revshare demand_tag_priorities: - supply_tag_id: 1 rate: 1.11 demand_tag_marketplace_deal_create_full: summary: Marketplace Deal Full value: name: Demand Tag Name demand_class: 12 demand_partner_id: 1 allowed_player_sizes: - s - m - l format: video environment: desktop demand_tag_priorities: - supply_tag_id: 1 priority: 1 tier: 1 ratio: 1 domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true demand_label_ids: - 1 rate: 1.11 rate_currency: USD curator_fee_type: revshare curator_fee_currency: USD budget_timezone: America/New_York daa_ad_choices: true device_id_required: true active: true note: Demand Tag note demand_tag_update_simple: summary: Simple value: name: Demand Tag Name rate: 1.11 active: true demand_tag_update_full: summary: Full value: name: Demand Tag Name campaign_id: 1 creative_id: 1 allowed_player_sizes: - s - m - l environment: desktop domain_targeting: Allowlist domain_list_ids: - 1 country_targeting: Include country_source: list country_list_ids: - 1 key_value_targeting: true segment_targeting_enabled: true competitive_exclusions_enabled: true competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 demand_label_ids: - 1 rate: 1.11 rate_currency: USD booked_revenue: 1.11 budget_timezone: America/New_York non_billable_fees: - cost_basis: impressions value: 1.11 currency: USD advanced_floor_rules: - dimension: adomain values: - example.com floor_price: 1.11 daa_ad_choices: true device_id_required: true is_reserved: false active: true note: Demand Tag note demand_tag_key_create_simple: summary: Simple value: key_id: 1 group: Demand Tag Key Name demand_tag_key_type: values list_type: white_list value_ids: - 1 demand_tag_key_create_full: summary: Full value: key_id: 1 group: Demand Tag Key Name demand_tag_key_type: values list_type: white_list key_required: true value_ids: - 1 free_values: [] value_list_ids: [] demand_tag_key_update_simple: summary: Simple value: demand_tag_key_type: values value_ids: - 1 demand_tag_key_update_full: summary: Full value: group: Demand Tag Key Name demand_tag_key_type: values list_type: white_list key_required: true value_ids: - 1 free_values: [] value_list_ids: [] demand_partner_create_simple: summary: Simple value: name: Demand Partner Name demand_partner_create_full: summary: Full value: name: Demand Partner Name code: dp_code secondary_code: dp_secondary_code default_tier: 1 creative_landing_page_url: https://ad.example.com/landing third_party_fee: 1.11 third_party_fee_currency: USD third_party_fee_metric: 0 third_party_fee_net_revenue: false nielsen_dar_active: false nielsen_traf_cid: '1' nielsen_custom_param_value: '1' audited_creative_statuses: [] targeting_spend_profile: budget_timezone: America/New_York budgets: - budget_period: daily budget_metric: impressions budget_value: 1 budget_pacing: smooth targeting_time_profile: start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting_users_timezone: false frequency_caps: - frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: springserve targeting_geo_profile: country_source: list country_white_list: true country_codes: - US country_list_ids: - 1 targeting_page_attribute_profile: domain_white_list: true domain_list_ids: - 1 app_name_white_list: true app_name_list_ids: - 1 app_bundle_white_list: true app_bundle_list_ids: - 1 ip_white_list: true ip_list_ids: - 1 daa_ad_choices: false euro_daa_ad_choices: false segment_targeting_enabled: false competitive_exclusions_enabled: false competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 advertiser_domain_white_list: true advertiser_domain_list_ids: - 1 blocking_unknown_advertiser_domains: false tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image non_billable_fees: - cost_basis: impressions value: '1.11' currency: USD account_manager_ids: - 1 note: Demand Partner note demand_partner_update_simple: summary: Simple value: name: Demand Partner Name demand_partner_update_full: summary: Full value: name: Demand Partner Name code: dp_code secondary_code: dp_secondary_code default_tier: 1 creative_landing_page_url: https://ad.example.com/landing third_party_fee: 1.11 third_party_fee_currency: USD third_party_fee_metric: 0 third_party_fee_net_revenue: false nielsen_dar_active: false nielsen_traf_cid: '1' nielsen_custom_param_value: '1' audited_creative_statuses: [] targeting_spend_profile: budget_timezone: America/New_York budgets: - id: 1 budget_period: daily budget_metric: impressions budget_value: 1 budget_pacing: smooth targeting_time_profile: start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York day_parting_users_timezone: false frequency_caps: - id: 1 frequency_cap_period: day frequency_cap_period_amount: 1 frequency_cap_metric: impressions frequency_cap_value: 1 frequency_cap_type: springserve targeting_geo_profile: country_source: list country_white_list: true country_codes: - US country_list_ids: - 1 targeting_page_attribute_profile: domain_white_list: true domain_list_ids: - 1 app_name_white_list: true app_name_list_ids: - 1 app_bundle_white_list: true app_bundle_list_ids: - 1 ip_white_list: true ip_list_ids: - 1 daa_ad_choices: false euro_daa_ad_choices: false segment_targeting_enabled: false competitive_exclusions_enabled: false competitive_exclusion_iab_source: list competitive_exclusion_iab_category_list_ids: - 1 advertiser_domain_white_list: true advertiser_domain_list_ids: - 1 blocking_unknown_advertiser_domains: false tag_pixels: - id: 1 pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image non_billable_fees: - id: 1 cost_basis: impressions value: '1.11' currency: USD account_manager_ids: - 1 note: Demand Partner note demand_label_create_simple: summary: Simple value: name: Demand Label Name demand_label_create_full: summary: Full value: name: Demand Label Name demand_tag_ids: - 1 demand_label_update_simple: summary: Simple value: name: Demand Label Name demand_label_update_full: summary: Full value: name: Demand Label Name demand_tag_ids: - 1 delivery_modifier_create_simple: summary: Simple value: name: Delivery Modifier Name multiplier_interaction: stacked modifier_rules: - modifier_rule_object: Country source_type: values multiplier: '1.10' country_codes: - US delivery_modifier_create_full: summary: Full value: name: Delivery Modifier Name description: Delivery Modifier Description active: true multiplier_interaction: stacked day_parting_users_timezone: false modifier_rules: - modifier_rule_object: Country source_type: values multiplier: '1.10' country_codes: - US - modifier_rule_object: DeviceType source_type: values multiplier: '0.90' user_agent_devices: - CTV - modifier_rule_object: DomainList source_type: list multiplier: '1.05' domain_list_ids: - 1 delivery_modifier_update_simple: summary: Simple value: name: Delivery Modifier Name active: true delivery_modifier_update_full: summary: Full value: name: Delivery Modifier Name description: Delivery Modifier Description active: true multiplier_interaction: stacked day_parting_users_timezone: false modifier_rules: - id: 1 modifier_rule_object: Country source_type: values multiplier: '1.10' country_codes: - US - modifier_rule_object: DeviceType source_type: values multiplier: '0.90' user_agent_devices: - CTV - modifier_rule_object: DomainList source_type: list multiplier: '1.05' domain_list_ids: - 1 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_update_simple: summary: Simple value: name: Deal List Name deal_list_update_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_deals_bulk_create_multiple: summary: Multiple value: deals: - 1 - 2 - 3 deal_list_deals_bulk_replace_single: summary: Single value: deals: - 1 deal_list_deals_bulk_replace_multiple: summary: Multiple value: deals: - 1 - 2 - 3 deal_id_list_create_simple: summary: Simple value: name: Deal ID List Name deal_id_list_create_full: summary: Full value: name: Deal ID List Name description: Deal ID list description active: true deal_id_list_update_simple: summary: Simple value: name: Deal ID List Name deal_id_list_update_full: summary: Full value: name: Deal ID List Name description: Deal ID list description active: true deal_id_list_deal_ids_bulk_create_single: summary: Single value: deal_ids: - deal-abc-123 deal_id_list_deal_ids_bulk_create_multiple: summary: Multiple value: deal_ids: - deal-abc-123 - deal-xyz-456 - deal-def-789 deal_id_list_deal_ids_bulk_replace_single: summary: Single value: deal_ids: - deal-abc-123 deal_id_list_deal_ids_bulk_replace_multiple: summary: Multiple value: deal_ids: - deal-abc-123 - deal-xyz-456 - deal-def-789 country_list_create_simple: summary: Simple value: name: Country List Name country_codes: - AL - AD country_list_create_full: summary: Full value: name: Country List Name description: Country List Description active: true country_codes: - AL - AD country_list_update_simple: summary: Simple value: name: Country List Name country_list_update_full: summary: Full value: name: Country List Name description: Country List Description active: true country_codes: - UA - US city_list_create_simple: summary: Simple value: name: City List Name city_codes: - 2988507 - 2643743 city_list_create_full: summary: Full value: name: City List Name description: City List Description active: true city_codes: - 2988507 - 2643743 city_list_update_simple: summary: Simple value: name: City List Name city_list_update_full: summary: Full value: name: City List Name description: City List Description active: true city_codes: - 2988507 - 2643743 campaign_managed_create_simple: summary: Managed Simple value: name: Campaign Name demand_partner_id: 1 has_rate: true rate: 1.11 campaign_managed_create_full: summary: Managed Full value: name: Campaign Name demand_partner_id: 1 code: '1' secondary_code: '1' has_rate: true rate: 1.11 rate_currency: USD booked_revenue: 1.11 cost_model_type: 0 partner_tier_override_enabled: true partner_tier_override: '1' demand_tiering: false guaranteed_delivery: false guaranteed_tier: '1' audited_creative_statuses: - '1' demand_tag_ids: - 1 campaign_tiers: - supply_tag_id: 1 tier: 1 slot_order: '1' slot_number: 1 tiles_screen_deduplication: false third_party_fee: 1.11 third_party_fee_currency: USD third_party_fee_metric: 0 third_party_fee_net_revenue: false non_billable_fees: - cost_basis: impressions value: 1.11 currency: USD tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://ad.example.com/pixel mediaocean_prisma_enabled: false mediaocean_prisma_order_id: '1' mediaocean_prisma_campaign_id: '1' mediaocean_prisma_placement_id: '1' mediaocean_prisma_campaign_link: https://prisma.example.com/campaign is_active: true note: Campaign note campaign_direct_connect_create_simple: summary: Direct Connect Simple value: name: Campaign Name demand_partner_id: 1 has_rate: false campaign_direct_connect_create_full: summary: Direct Connect Full value: name: Campaign Name demand_partner_id: 1 code: '1' secondary_code: '1' has_rate: false partner_tier_override_enabled: true partner_tier_override: '1' guaranteed_delivery: false guaranteed_tier: '1' audited_creative_statuses: - '1' demand_tag_ids: - 1 campaign_tiers: - supply_tag_id: 1 tier: 1 slot_order: '1' slot_number: 1 tiles_screen_deduplication: false third_party_fee: 1.11 third_party_fee_currency: USD third_party_fee_metric: 0 third_party_fee_net_revenue: false non_billable_fees: - cost_basis: impressions value: 1.11 currency: USD tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://ad.example.com/pixel is_active: true note: Campaign note campaign_tiles_dedup_create_simple: summary: Tiles Screen Deduplication Simple value: name: Campaign Name demand_partner_id: 1 has_rate: true rate: 1.11 tiles_screen_deduplication: true max_bids_per_screen: 1 campaign_tiles_dedup_create_full: summary: Tiles Screen Deduplication Full value: name: Campaign Name demand_partner_id: 1 code: '1' secondary_code: '1' has_rate: true rate: 1.11 rate_currency: USD booked_revenue: 1.11 cost_model_type: 0 partner_tier_override_enabled: true partner_tier_override: '1' guaranteed_delivery: false guaranteed_tier: '1' audited_creative_statuses: - '1' demand_tag_ids: - 1 campaign_tiers: - supply_tag_id: 1 tier: 1 slot_order: '1' slot_number: 1 tiles_screen_deduplication: true max_bids_per_screen: 1 third_party_fee: 1.11 third_party_fee_currency: USD third_party_fee_metric: 0 third_party_fee_net_revenue: false non_billable_fees: - cost_basis: impressions value: 1.11 currency: USD tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://ad.example.com/pixel is_active: true note: Campaign note campaign_update_simple: summary: Simple value: name: Campaign Name rate: 1.11 demand_tag_ids: - 1 is_active: true campaign_update_full: summary: Full value: name: Campaign Name demand_partner_id: 1 code: '1' secondary_code: '1' has_rate: true rate: 1.11 rate_currency: USD booked_revenue: 1.11 cost_model_type: 0 partner_tier_override_enabled: true partner_tier_override: '1' guaranteed_delivery: false guaranteed_tier: '1' audited_creative_statuses: - '1' demand_tag_ids: - 1 campaign_tiers: - supply_tag_id: 1 tier: 1 slot_order: '1' slot_number: 1 tiles_screen_deduplication: false third_party_fee: 1.11 third_party_fee_currency: USD third_party_fee_metric: 0 third_party_fee_net_revenue: false non_billable_fees: - cost_basis: impressions value: 1.11 currency: USD tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://ad.example.com/pixel is_active: true note: Campaign note buying_strategy_create_simple: summary: Simple value: supply_partner_id: 1 rate: 1.11 rate_currency: USD buying_strategy_create_full: summary: Full value: supply_partner_id: 1 name: Connected Supply Name rate: 1.11 rate_currency: USD active: true environment: desktop revenue_model_type: 0 domain_targeting: true domain_list_ids: - 1 app_name_targeting: true app_name_list_ids: - 1 app_bundle_targeting: true app_bundle_list_ids: - 1 ip_targeting: true ip_list_ids: - 1 country_targeting: true country_source: list country_list_ids: - 1 state_targeting: true state_source: list state_list_ids: - 1 city_targeting: true city_source: list city_list_ids: - 1 metro_area_targeting: true metro_area_source: list metro_area_list_ids: - 1 postal_code_targeting: true postal_code_source: list postal_code_list_ids: - 1 allowed_player_sizes: - s - m - l segment_targeting_enabled: false targeted_macros_enabled: false blocking_unknown_advertiser_domains: false pre_bid_blocking_enabled: false post_imp_detection_enabled: false budget_timezone: America/New_York tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp buying_strategy_update_simple: summary: Simple value: active: true buying_strategy_update_full: summary: Full value: name: Connected Supply Name active: true environment: desktop domain_targeting: true domain_list_ids: - 1 app_name_targeting: true app_name_list_ids: - 1 app_bundle_targeting: true app_bundle_list_ids: - 1 ip_targeting: true ip_list_ids: - 1 country_targeting: true country_source: list country_list_ids: - 1 state_targeting: true state_source: list state_list_ids: - 1 city_targeting: true city_source: list city_list_ids: - 1 metro_area_targeting: true metro_area_source: list metro_area_list_ids: - 1 postal_code_targeting: true postal_code_source: list postal_code_list_ids: - 1 allowed_player_sizes: - s - m - l segment_targeting_enabled: false targeted_macros_enabled: false blocking_unknown_advertiser_domains: false pre_bid_blocking_enabled: false post_imp_detection_enabled: false budget_timezone: America/New_York tag_pixels: - pixel_type: AdImpression pixel_format: image pixel_url: https://pixel.example.com/imp demand_tag_priorities: - demand_tag_id: 1 priority: 1 tier: 1 bill_create_simple: summary: Simple value: name: Bill Name month: '2026-01-01' currency: USD is_invoice: false is_direct_connect: false is_openrtb: false bill_create_full: summary: Full value: name: Bill Name month: '2026-01-01' currency: USD is_invoice: false is_direct_connect: false is_openrtb: false bill_update_simple: summary: Simple value: name: Bill Name bill_update_full: summary: Full value: name: Bill Name month: '2026-01-01' currency: USD is_invoice: false is_direct_connect: false is_openrtb: false bill_item_create_simple: summary: Simple value: label: Bill Item Label unit_cost: 1.11 units: 1.11 total_cost: 1.11 bill_item_create_full: summary: Full value: label: Bill Item Label other_account_id: 1 unit_cost: 1.11 units: 1.11 total_cost: 1.11 xero_account_code: 401 is_unit_cost_cpm: true is_synced: false bill_item_update_simple: summary: Simple value: label: Bill Item Label unit_cost: 1.11 bill_item_update_full: summary: Full value: label: Bill Item Label other_account_id: 1 unit_cost: 1.11 units: 1.11 total_cost: 1.11 xero_account_code: 401 is_unit_cost_cpm: true is_synced: false bid_modifier_create_simple: summary: Simple value: name: Bid Modifier Name multiplier_interaction: stacked modifier_rules: - modifier_rule_object: Country source_type: values multiplier: '1.10' country_codes: - US bid_modifier_create_full: summary: Full value: name: Bid Modifier Name description: Bid Modifier Description active: true multiplier_interaction: stacked day_parting_users_timezone: false modifier_rules: - modifier_rule_object: Country source_type: values multiplier: '1.10' country_codes: - US - modifier_rule_object: DeviceType source_type: values multiplier: '0.90' user_agent_devices: - CTV - modifier_rule_object: DomainList source_type: list multiplier: '1.05' domain_list_ids: - 1 bid_modifier_update_simple: summary: Simple value: name: Bid Modifier Name active: true bid_modifier_update_full: summary: Full value: name: Bid Modifier Name description: Bid Modifier Description active: true multiplier_interaction: stacked day_parting_users_timezone: false modifier_rules: - id: 1 modifier_rule_object: Country source_type: values multiplier: '1.10' country_codes: - US - modifier_rule_object: DeviceType source_type: values multiplier: '0.90' user_agent_devices: - CTV - modifier_rule_object: DomainList source_type: list multiplier: '1.05' domain_list_ids: - 1 audio_creative_create_simple: summary: Simple value: name: Audio Creative Name demand_partner_id: 1 creative_remote_url: https://example.com/audio.mp3 audio_creative_create_full: summary: Full value: name: Audio Creative Name demand_partner_id: 1 creative_remote_url: https://example.com/audio.mp3 code: audio-code secondary_code: audio-secondary advertiser_domain: example.com iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_source: list country_list_ids: - 1 state_source: list state_list_ids: - 1 city_source: list city_list_ids: - 1 metro_area_source: list metro_area_list_ids: - 1 postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image active: true audio_creative_update_simple: summary: Simple value: name: Audio Creative Name active: true audio_creative_update_full: summary: Full value: name: Audio Creative Name code: audio-code secondary_code: audio-secondary advertiser_domain: example.com iab_tier_1_category_codes: - IAB1 iab_tier_2_category_codes: - IAB1-1 line_item_demand_tag_ids: - 1 country_source: list country_list_ids: - 1 state_source: list state_list_ids: - 1 city_source: list city_list_ids: - 1 metro_area_source: list metro_area_list_ids: - 1 postal_code_source: list postal_code_list_ids: - 1 key_value_targeting: true budget_timezone: America/New_York start_date: '2026-01-01' end_date: '2026-12-31' flight_dates_timezone: America/New_York tag_pixels: - pixel_type: AdImpression pixel_url: https://pixel.example.com/imp pixel_format: image active: true app_name_list_create_simple: summary: Simple value: name: App Name List Name app_name_list_create_full: summary: Full value: name: App Name List Name description: App Name List Description partial_match: false active: true app_name_list_update_simple: summary: Simple value: name: App Name List Name active: true app_name_list_update_full: summary: Full value: name: App Name List Name description: App Name List Description partial_match: false active: true app_name_list_names_bulk_single: summary: Single value: app_names: - Example App Name app_name_list_names_bulk_multiple: summary: Multiple value: app_names: - Example App Name - Another App Name - Third App Name app_bundle_list_create_simple: summary: Simple value: name: App Bundle List Name app_bundle_list_create_full: summary: Full value: name: App Bundle List Name description: App Bundle List Description partial_match: false active: true app_bundle_list_update_simple: summary: Simple value: name: App Bundle List Name active: true app_bundle_list_update_full: summary: Full value: name: App Bundle List Name description: App Bundle List Description partial_match: false active: true app_bundle_list_bundles_bulk_single: summary: Single value: app_bundles: - com.example.app app_bundle_list_bundles_bulk_multiple: summary: Multiple value: app_bundles: - com.example.app - com.example.app2 - com.example.app3 advertiser_domain_list_create_simple: summary: Simple value: name: Advertiser Domain List Name advertiser_domain_list_create_full: summary: Full value: name: Advertiser Domain List Name description: Advertiser Domain List Description active: true advertiser_domain_list_update_simple: summary: Simple value: name: Advertiser Domain List Name active: true advertiser_domain_list_update_full: summary: Full value: name: Advertiser Domain List Name description: Advertiser Domain List Description active: true advertiser_domain_list_domains_bulk_single: summary: Single value: names: - example1.com advertiser_domain_list_domains_bulk_multiple: summary: Multiple value: names: - example1.com - example2.com - example3.com account_update_simple: summary: Simple value: tier_a_active: true account_update_full: summary: Full value: tier_a_active: true tier_b_active: false tier_c_active: false tier_e_active: false tier_f_active: false schemas: DeliveryModifierCreate: type: object required: - name - modifier_rules properties: name: type: string description: Modifier title description: type: string description: Add your own description active: type: boolean description: Default true default: true modifier_rules: type: array minItems: 1 description: At least one rule object required items: "$ref": "#/components/schemas/DeliveryModifierRule" DeliveryModifierRule: type: object required: - source_type - multiplier - modifier_rule_object properties: id: type: integer description: Include when updating an existing rule source_type: type: string enum: - values - list description: | - "values" = provide raw values (e.g. modifier_rule_values, country_codes) - "list" = reference list IDs (e.g. deal_id_list_ids, domain_list_ids) multiplier: type: string description: Multiplier as decimal string, e.g. "1.05" (5% increment), "0.95" (5% decrement) modifier_rule_object: type: string enum: - DeviceType - OperatingSystem - DealIdList - PublisherIdList - DomainList - AppBundleList - AppNameList - Country - MetroArea - State - City - PostalCode description: Determines which values key to use (see Values Key Name mapping) modifier_rule_values: type: array items: type: string description: For DealIdList, PublisherIdList, DomainList, AppBundleList, AppNameList user_agent_devices: type: array items: type: string description: For DeviceType (source_type=values only) user_agent_operating_systems: type: array items: type: string description: For OperatingSystem (source_type=values only) country_codes: type: array items: type: string description: For Country (source_type=values) metro_area_codes: type: array items: type: string description: For MetroArea (source_type=values) state_codes: type: array items: type: string description: For State (source_type=values) city_codes: type: array items: type: string description: For City (source_type=values) postal_codes: type: array items: type: string description: For PostalCode (source_type=values) deal_id_list_ids: type: array items: type: integer description: For DealIdList (source_type=list) publisher_id_list_ids: type: array items: type: integer description: For PublisherIdList (source_type=list) domain_list_ids: type: array items: type: integer description: For DomainList (source_type=list) app_bundle_list_ids: type: array items: type: integer description: For AppBundleList (source_type=list) app_name_list_ids: type: array items: type: integer description: For AppNameList (source_type=list) country_list_ids: type: array items: type: integer description: For Country (source_type=list) metro_area_list_ids: type: array items: type: integer description: For MetroArea (source_type=list) state_list_ids: type: array items: type: integer description: For State (source_type=list) city_list_ids: type: array items: type: integer description: For City (source_type=list) postal_code_list_ids: type: array items: type: integer description: For PostalCode (source_type=list) 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 tags: - name: Auth description: Endpoints that provide authentication for the API - name: Accounts - name: Advertiser Domain Lists - name: App Bundle Lists - name: App Name Lists - name: Audios - name: Bid Maps - name: Bills - name: Campaigns - name: City Lists - name: Connected Demand - name: Connected Supply - name: Country Lists - name: Creatives - name: Deal Id Lists - name: Deal Lists - name: Demand Labels - name: Demand Partners - name: Demand Tags - name: Direct Connection Clearing Terms - name: Direct Connections - name: Domain Lists - name: First Party Partner Segments - name: Forecast - name: Global Fcap Pixels - name: Hb Bid Maps - name: Ip Lists - name: Keys - name: Metro Area Lists - name: Operative - name: Parameter Lists - name: Partner Segments - name: Postal Code Lists - name: Publisher Id Lists - name: Report - name: Reports - name: Segments - name: State Lists - name: Supply Labels - name: Supply Partners - name: Supply Routers - name: Supply Tags - name: Tag Creatives - name: Tiles - name: Users - name: Value Lists - name: Videos security: - api_key: [] - bearer_token: []