---
title: "Update banner custom parameters"
type: reference
method: POST
path: /rest-api/banner/{bannerId}/custom/parameters.do
tag: "Banners"
---

# Update banner custom parameters

`POST https://YOUR-NETWORK-DOMAIN/rest-api/banner/{bannerId}/custom/parameters.do`

Replaces the custom key-value parameters for the specified banner. The request body is a JSON array of objects with optional 'id' (for existing parameters), 'name', and 'value' fields. Omitting 'id' creates a new parameter; the banner's parameters the array leaves out are deleted. An id that is not one of this banner's parameters, or an entry without name or value, is refused with 400 and nothing changes; so is a banner that is not native (EXTERNAL_NATIVE or LOCAL_NATIVE), where the parameters would do nothing. Requires UPDATE permission on the banner's advertiser.

## Path params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `bannerId` | integer | yes | `3001` | ID of the banner to update custom parameters for |

## Body

A JSON body. An example, built from the field definitions:

```json
[
  {
    "id": "0",
    "name": "headline",
    "value": "Buy Now — 50% Off!"
  }
]
```

## Responses

- `200` — Custom parameters updated successfully
- `400` — Wrong request format, an invalid entry, or an id that is not one of the banner's parameters
- `401` — Authentication error
- `403` — Not enough permissions
- `404` — Not found — resource does not exist

## Example request

```bash
curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/custom/parameters.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "id": "0",
    "name": "headline",
    "value": "Buy Now — 50% Off!"
  }
]'
```

Source: https://epom.com/ad-server/docs/api/banners/post-banner-custom-parameters