---
title: "Change one DSP partner's settings"
type: reference
method: POST
path: /rest-api/dsp-partners/{id}.do
tag: "DSP Partners"
---

# Change one DSP partner's settings

`POST https://YOUR-NETWORK-DOMAIN/rest-api/dsp-partners/{id}.do`

Changes only the settings the call names and leaves every other one as it is, so a client that is switching a partner off does not have to send its endpoint, its currency and its parameters back to keep them. Each one is checked the way the console checks it, and a call that fails a check changes nothing at all. Switching a partner off stops it being offered anywhere new while the creatives that already name it keep it; switching one on is refused while its currency has no rate to price it by, exactly as the page refuses it. The currency and contractual rate, the supply-chain domain, user matching, the per-partner parameters and analytics sync are not changed here: each is checked against the other fields of the page's form, which a call naming three settings cannot supply. Read the partner back to confirm what was stored. Requires the DSP Partners permission.

## Path params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `id` | integer | yes | `12` | The partner's id |

## Form params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `name` | string | no | `TrafficStars` | The partner's name, as the console and the reports show it |
| `active` | boolean | no | `true` | Whether the partner is asked for bids at all; a switched-off partner keeps the creatives that name it |
| `url` | string | no | `https://bid.partner.example/rtb` | The bid endpoint this partner is asked at |
| `timeout` | integer | no | `300` | Milliseconds the bid may take, 0-30000; it is also the tmax the request carries |
| `nurlTimeout` | integer | no | `5000` | Milliseconds a win or loss notice may take, 0-60000; empty for the platform default of 5000 |
| `maxQueriesPerSecond` | integer | no | `500` | Most bid requests a second this partner is sent; 0 blocks it, empty is unlimited |
| `pricingModel` | string | no | `CPM` | What the partner is billed on: CPM, CPC or CPI. A model that does not match how it reports books zero |
| `protocolVersion` | string | no | `V_2_5` | The OpenRTB version the bid request is written in |
| `nativeProtocolVersion` | string | no | `V_1_2` | The OpenRTB Native version a native bid request is written in |
| `encryptionType` | string | no | `NO_ENCRYPTION` | How the macros this partner is sent are encrypted: NO_ENCRYPTION, BASE64 or BLOWFISH |
| `secondPriceOnly` | boolean | no | `false` | Settle a win at the runner-up's price rather than the bid |
| `headerBiddingEnabled` | boolean | no | `false` | Ask this partner on header-bidding requests as well |
| `gzipBidRequest` | boolean | no | `false` | Send the bid request gzipped |
| `wrapClickThrough` | boolean | no | `true` | Count the click here before sending the visitor on to the partner's landing page |
| `nativeRequestWrap` | boolean | no | `true` | Wrap the native bid request in its OpenRTB envelope |
| `nativeResponseWrap` | boolean | no | `true` | Expect the native bid response in its OpenRTB envelope |
| `creativeScanProvider` | string | no | `GEO_EDGE` | Which provider scans this partner's creatives: MEDIA_TRUST, GEO_EDGE, or NONE to trust them unscanned. A provider the network has no account for is refused |

## Responses

- `200` — {success, id, changed:[...]}
- `400` — A value is outside the range the console allows, or a rule it enforces is broken
- `401` — Authentication error
- `403` — The caller does not hold the DSP Partners permission
- `404` — No partner with this id

## Example request

```bash
curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/dsp-partners/12.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'name=TrafficStars' \
  --data-urlencode 'active=true' \
  --data-urlencode 'url=https://bid.partner.example/rtb'
```

Source: https://epom.com/ad-server/docs/api/dsp-partners/post-dsp-partners