PUT /v3/advertiser/bidlist → advertiserAssociateBidList

Overview

Property Value
REST endpoint PUT /v3/advertiser/bidlist
GraphQL operation advertiserAssociateBidList
Input type AdvertiserAssociateBidListInput
Output type PayloadWithErrorsOfAdvertiser (data: Advertiser, userErrors: [UserError!]!)

Multi-step operations

REST PUT /v3/advertiser/bidlist replaces the full association set in one call. In GraphQL, supply the desired lists via bidListsToAddOrUpdate and use bidListIdsToRemove for any lists omitted from the new set that should be disassociated.

Input field mapping

Input type: AdvertiserAssociateBidListInput

REST field GraphQL field GraphQL type Required Notes
AdvertiserId advertiserId ID! Required N/A
AssociatedBidLists bidListsToAddOrUpdate [BidListAddOrUpdateInput!] Required REST PUT replaces the full association set; may also need bidListIdsToRemove for removals
AssociatedBidLists[].BidListId bidListsToAddOrUpdate[].bidListId ID! Required N/A
AssociatedBidLists[].IsEnabled bidListsToAddOrUpdate[].isEnabled Boolean Optional N/A
AssociatedBidLists[].IsDefaultForDimension N/A Boolean Optional Not exposed on AdvertiserAssociateBidListInput
AssociatedBidLists[].BidListSource N/A BidListSource Optional Read-only
AssociatedBidLists[].BidListAdjustmentType N/A BidListAdjustmentType Optional Read-only
AssociatedBidLists[].BidListDimensions N/A [BidListDimension!] Optional Read-only

Output field mapping

Output type: Advertiser (returned as data)

REST response field GraphQL field GraphQL type Nullable Notes
AdvertiserId id ID! Not nullable N/A
AssociatedBidLists associatedBidLists AssociatedBidListsConnection Nullable N/A
AssociatedBidLists[].BidListId associatedBidLists.nodes[].bidList.id ID! Not nullable Via nested bidList on AssociatedBidList
AssociatedBidLists[].IsEnabled associatedBidLists.nodes[].isEnabled Boolean! Not nullable N/A
AssociatedBidLists[].IsDefaultForDimension N/A Boolean Nullable Not currently available in GraphQL
AssociatedBidLists[].BidListSource associatedBidLists.nodes[].bidList.source BidListSource! Not nullable N/A
AssociatedBidLists[].BidListAdjustmentType associatedBidLists.nodes[].bidList.adjustmentType BidListAdjustmentType! Not nullable N/A
AssociatedBidLists[].BidListDimensions associatedBidLists.nodes[].bidList.dimensions [BidListDimension!]! Not nullable N/A

Code examples

REST example

PUT /v3/advertiser/bidlist HTTP/1.1
Content-Type: application/json
TTD-Auth: AUTH_TOKEN_PLACEHOLDER

{
  "AdvertiserId": "adv123",
  "AssociatedBidLists": [
    { "BidListId": "bl456", "IsEnabled": true },
    { "BidListId": "bl789", "IsEnabled": false }
  ]
}

GraphQL example

POST /graphql HTTP/1.1
Content-Type: application/json
TTD-Auth: AUTH_TOKEN_PLACEHOLDER
mutation {
  advertiserAssociateBidList(
    input: {
      advertiserId: "adv123"
      bidListsToAddOrUpdate: [
        { bidListId: "bl456", isEnabled: true }
        { bidListId: "bl789", isEnabled: false }
      ]
    }
  ) {
    data {
      id
      associatedBidLists {
        nodes {
          isEnabled
          bidList { id }
        }
      }
    }
    userErrors {
      message
      field
    }
  }
}