---
title: "IP Address Audiences"
slug: "ip-address"
updated: 2026-04-21T13:55:11Z
published: 2026-04-21T13:55:11Z
canonical: "help.yahooinc.com/ip-address"
---

> ## 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.

# IP Address Audiences

> [!WARNING]
> Important
> 
> This endpoint for IP Address Audiences now supports Email Address, Phone Number and Device ID audience types. This endpoint will be renamed to [Custom Audiences](/dsp-api/docs/custom-audiences).

An IP Address audience is a custom audience you create by providing a list of SHA256-hashed IP addresses.

## Hierarchy

Define an `IP Address` audience at the advertiser level.

## Endpoint

```plaintext
/traffic/audiences/customsegments
```

Use the following HTTP methods:

- Use the `GET` method to read an existing IP Address audience.
- Use the `POST` method to create a new IP Address audience.
- Use the `PUT` method to update an existing IP Address audience.

## Resources

The `IP Address` audience object contains the following fields:

| **Field** | **Description** | **Data Type** | **Create** | **Update** |
| --- | --- | --- | --- | --- |
| `id` | Specifies the audience ID. | `integer` | N/A | Required |
| `name` | Specifies the name of the audience. | `string` | Required | Optional |
| `status` | Specifies the current status of the audience. Allowed values: - `ACTIVE`: you can target the audience. - `INACTIVE`: you cannot target the audience. Defaults to `ACTIVE` if you don’t specify a value. | `string` | Optional | Optional |
| `accountId` | Specifies the advertiser ID. An audience is tied to its advertiser and you can only use it in that advertiser’s campaigns. To learn more, refer to [Advertisers](/dsp-api/docs/advertisers). | `integer` | Required | Required |
| `retentionDays` | Specifies the number of days custom audience data is retained. Allowed values: - `30` - `60` - `90` - `180` Defaults to `180` if a value is not selected. | `integer` | Optional | Optional |
| `seedList` | Specifies an array of email addresses hashed using the [SHA256](https://en.wikipedia.org/wiki/SHA-2) cryptographic hashing algorithm. At least 1 item is required, the limit is 50K items per request. | `array` | Required | Optional |
| `seedListType` | In the case of IP Address audiences, the value of this field has to be `SHA256IP`. - For `POST`, it is always required. - For `PUT`, it is only required when the `seedList` is also sent. | `string` | Required | Optional |
| `seedListAction` | Specifies the operation which will be performed on the provided seedList. Allowed values: - `ADD`: insert the provided `seedList` entries. - `DELETE`: remove the provided `seedList` entries. Defaults to `ADD` if you don’t specify a value. | `string` | Optional | Optional |
| `createdAt` | A read-only field that specifies when the audience was created. | `string` | N/A | N/A |

## Read Audience

Read an IP Address audience.

```plaintext
GET traffic/audiences/customsegments/{id}?accountId={accountId}
```

### Parameters

| **Parameter** | **Parameter Type** | **Description** | **Data Type** | **Required** |
| --- | --- | --- | --- | --- |
| `id` | path | Specifies the audience ID. | `integer` | Y |
| `accountId` | query | Specifies the advertiser ID. | `integer` | Y |

### Sample Request URL

```plaintext
GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences/customsegments/53095732?accountId=2757689
```

### Sample Response

```plaintext
{
  "response": {
    "status": "ACTIVE",
    "id": 53095732,
    "name": "Traffic Create IP Custom Audience",
    "accountId": 2757689,
    "retentionDays": 180,
    "createdAt": "2021-05-14"
  },
  "errors": null,
  "timeStamp": "2021-05-14T10:28:53.389Z"
}
```

## Create Audience

Create a new IP Address audience.

```plaintext
POST /traffic/audiences/customsegments
```

### Parameters

Specify all fields in the body of the `application/json` payload.

### Sample Request URL

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

### Sample Request Body

```plaintext
{
  "accountId": 2757689,
  "name": "Traffic Create IP Custom Audience",
  "seedListType": "SHA256IP",
  "seedListAction": "ADD",
  "seedList": [
      "4cda9cd051e28cce2c10baa075b16fce29dc20014d443004ea9fac1b532c5453",
      "edd1f211054d7c1f7d5cc4baceedb4d9b5231d65aa82ea0892f8ab821e6d2006",
      "d230a1f9533d2218bcdce1c67a1b89c057c0c7adb2e2b53d4e2f8ac296aa9530",
      "e2ac40fc7e5fc9571c0952491784f948bc6a98549db1a33a6abdda993ff1e0d9"
  ],
  "status": "ACTIVE"
}
```

### Sample Response

```plaintext
{
   "response": {
     "status": "ACTIVE",
     "id": 53095732,
     "name": "Traffic Create IP Custom Audience",
     "accountId": 2757689,
     "retentionDays": 180,
     "createdAt": "2021-05-14"
   },
   "errors": null,
   "timeStamp": "2021-05-14T10:03:54.060Z"
}
```

## Update Audience

Update an existing IP Address audience.

```plaintext
PUT /traffic/audiences/customsegments/{id}
```

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

### Parameters

Specify the audience `id` in the endpoint path. Specify all other fields in the body of the `application/json` payload.

### Sample Request URL

```plaintext
PUT https://dspapi.admanagerplus.yahoo.com/traffic/audiences/customsegments/53095732
```

### Sample Request Body

```plaintext
{
  "accountId": 2757689,
  "name": "Traffic Create IP Custom Audience Updated",
  "status": "INACTIVE",
}
```

### Sample Response

```plaintext
{
  "response": {
    "status": "INACTIVE",
    "id": 53095732,
    "name": "Traffic Create IP Custom Audience Updated",
    "accountId": 2757689,
    "retentionDays": 180,
    "createdAt": "2021-05-14"
  },
  "errors": null,
  "timeStamp": "2021-05-14T10:15:50.678Z"
}
```

## Delete Audience

You cannot delete IP Address audiences using the DSP Traffic API.