---
title: "Switch banners on or off"
type: reference
method: POST
path: /rest-api/banners/status.do
tag: "Banners"
---

# Switch banners on or off

`POST https://YOUR-NETWORK-DOMAIN/rest-api/banners/status.do`

Sets the active status of up to 500 banners in one call. Banners already in the requested state are skipped as 'unchanged', deleted or unknown ids as 'deleted' / 'not-found', and a TEMPLATE banner whose template is inactive is skipped as 'inactive-template' when switched on without the UPDATE_PROPERTIES_OF_INACTIVE_TEMPLATE permission. The response lists changed ids and skipped {id, reason} pairs. The batch is all-or-nothing on permissions: without MANAGE_BANNERS_ACTIVE_STATUS, or if any banner's advertiser is outside the caller's UPDATE share, nothing changes. Each switched banner sends the same activated / deactivated notification as a single update.

## Form params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `ids` | array<integer> | yes | `3001` | Banner IDs to switch, 1 to 500 |
| `active` | boolean | yes | `true` | true to switch the banners on, false to switch them off |

## Responses

- `200` — Batch applied
- `400` — No ids, or more than 500
- `401` — Authentication error
- `403` — Not enough permissions for the whole batch
- `404` — None of the ids names an existing banner

## Example request

```bash
curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banners/status.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'ids=3001' \
  --data-urlencode 'active=true'
```

Source: https://epom.com/ad-server/docs/api/banners/post-banners-status