---
title: "Supply Lists"
slug: "supply-lists"
updated: 2025-09-17T19:57:48Z
published: 2025-09-17T19:57:48Z
canonical: "help.yahooinc.com/supply-lists"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.yahooinc.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Supply Lists

Use the `sitelists` endpoint to manage supply lists, which can include app lists, site lists and seller id lists, to allow or deny apps, sites (URLs) or seller ids for display, video and native lines.

- **App lists** - Lists of mobile apps.
- **Site lists** - Lists of websites.
- **Seller ID lists** - Lists of seller ids.

Create as many app lists, site lists and seller id lists for a single advertiser, or shared across all the advertisers in a seat.

## Hierarchy

A supply list can be set at the seat level or the advertiser level.

- Seat-level app, site and seller id lists are shared by every advertiser in the seat.
- Advertiser-level app, site and seller id lists are specific to a single advertiser.

## Endpoint

```plaintext
/traffic/sitelists
```

Use the following HTTP methods:

- Use the `GET` method to view an existing app list or site or seller id list.
- Use the `POST` method to create a new app list, site or seller id list.
- Use the `PUT` method to update an existing app list, site or seller id list.

## Required and Supported Fields

### Site List

The `sitelists` object contains the following fields.

| **Field** | **Description** | **Data Type** | **Create** | **Update** |
| --- | --- | --- | --- | --- |
| `id` | Specifies the app, site or seller id list ID. | `integer` | N/A | Required |
| `name` | Specifies the name of the app, site or seller id list. | `string` | Required | Required |
| `accountId` | Specifies the advertiser ID. To learn more, refer to [Advertisers](/dsp-api/docs/advertisers). | `integer` | Required | Optional |
| `status` | Specifies the current status of the app, site or seller id list. Allowed values: - `ACTIVE`: the app or site list is active. - `INACTIVE`: the app or site list is inactive. - `ARCHIVED`: the app or site list is archived. | `string` | Required | Required |
| `type` | Specifies the type of list. Allowed values: - `SITE_LIST`: The list contains websites. - `APP_LIST`: The list contains mobile apps. - `SELLER_ID_LIST`: The list contains seller ids. | `string` | Required | Optional |
| `isShared` | Enable or disable sharing the list across advertisers in your seat. Sharing makes the app, site or seller id list available for other advertisers to use for targeting. - If `true`, Enable sharing. - If `false`, Disable sharing. Defaults to `false`. | `boolean` | Optional | Optional |
| `items` | Specifies an array of [items objects](/dsp-api/docs/app-site-lists#items). | `array` | Required | Optional |

### Items

Each element in the `items` object contains the following fields:

| **Field** | **Description** | **Data Type** | **Create** | **Update** |
| --- | --- | --- | --- | --- |
| `id` | Specifies the item ID. | `integer` | N/A | N/A |
| `itemName` | Specifies the name of the item. - If the type is `SITE_LIST`, this field represents the site URL. - If the type is `APP_LIST`, this field represents the mobile app name. - If the type is `SELLER_ID_LIST`, this field represents the seller id list name. | `string` | Required | Required |

## Read a Supply List

Get data for a specific app, site or seller id list.

```plaintext
GET /traffic/sitelists/{id}
```

### Parameters

| **Parameter** | **Parameter Type** | **Description** | **Data Type** | **Required** |
| --- | --- | --- | --- | --- |
| `id` | path | Specifies the app, site or seller id list ID. | `integer` | Y |

### Example Request URL

```plaintext
GET https://dspapi.admanagerplus.yahoo.com/traffic/sitelists/67358
```

### Example Response

```json
{
  "response": {
    "status": "ACTIVE",
    "type": "SITE_LIST",
    "id": 67358,
    "name": "test-site-list-1",
    "accountId": 1356341,
    "isShared": false,
    "updatedAt": "2017-09-22T05:45:36Z",
    "items": [
      {
        "id": 1992605,
        "itemName": "http://yahoo.com"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2017-09-22T05:45:35Z"
}
```

## Create a Supply List

Create a new app, site or seller id list.

```plaintext
POST /traffic/sitelists/
```

### Parameters

All fields are specified in the body of the `application/json` payload.

### Sample Request URL

```plaintext
POST https://dspapi.admanagerplus.yahoo.com/traffic/sitelists
```

### Sample Request Body - Site List

```json
{
  "accountId": 1356341,
  "name": "test-site-list-1",
  "status": "ACTIVE",
  "type": "SITE_LIST",
  "isShared": false,
  "items": [
    {
      "itemName": "http://yahoo.com"
    }
  ]
}
```

### Sample Response - Site List

```json
{
  "response": {
    "status": "ACTIVE",
    "type": "SITE_LIST",
    "id": 67358,
    "name": "test-site-list-1",
    "accountId": 1356341,
    "isShared": false,
    "updatedAt": "2017-09-22T05:45:36Z",
    "items": [
      {
        "id": 1992605,
        "itemName": "http://yahoo.com"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2017-09-22T05:45:35Z"
}
```

### Sample Request Body - Seller ID List

```json
{
    "accountId": 75566,
    "name": "Seller List",
    "status": "ACTIVE",
    "type": "SELLER_ID_LIST",
    "isShared": false,
    "items": [
    {
      "itemName": "name-1",
      "exchangeName": "Direct Publishers"
    }
    ]
}
```

### Sample Response - Seller ID List

```json
{
    "response": {
        "id": 200741,
        "accountId": 75566,
        "name": "Seller List",
        "isShared": false,
        "updatedAt": "2025-09-12T16:38:01Z",
        "items": [
            {
                "itemName": "name-1",
                "publisherIds": [
                    140
                ]
            }
        ],
        "status": "ACTIVE",
        "type": "SELLER_ID_LIST"
    },
    "errors": null,
    "timeStamp": "2025-09-12T16:38:00.833Z"
}
```

## Update a Supply List

Update an existing app, site or seller id list.

```plaintext
PUT /traffic/sitelists/{id}
```

Partial updates are supported; values of supported fields that are not in the payload remain unchanged.

### Parameters

The Site List `id` is specified in the url path. All other fields are specified in the body of the `application/json` payload.

### Sample Request URL

```plaintext
PUT https://dspapi.admanagerplus.yahoo.com/traffic/sitelists/67358
```

### Sample Request Body

```json
{
  "accountId": 1356341,
  "status": "ACTIVE",
  "type": "APP_LIST",
  "items": [
    {
      "itemName": "Angry Birds"
    }
  ]
}
```

### Sample Response

```json
{
  "response": {
    "status": "ACTIVE",
    "type": "APP_LIST",
    "id": 67358,
    "name": "test-site-list-1",
    "accountId": 1356341,
    "isShared": false,
    "updatedAt": "2017-09-22T05:50:57Z",
    "items": [
      {
        "id": 1992606,
        "itemName": "Angry Birds"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2017-09-22T05:50:57Z"
}
```

## Delete a Supply List

The DSP Traffic API does not support the deletion of app, site or seller id lists.