# Enables a banner.

POST https://app.unleash-instance.example.com/api/admin/banners/{id}/on

**Enterprise feature**

Enables an existing banner, identified by its id.

Reference: https://docs.getunleash.io/api/enable-banner

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Enables a banner.
  version: endpoint_banners.enableBanner
paths:
  /api/admin/banners/{id}/on:
    post:
      operationId: enable-banner
      summary: Enables a banner.
      description: |-
        **Enterprise feature**

        Enables an existing banner, identified by its id.
      tags:
        - - subpackage_banners
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Header authentication of the form `undefined <token>`
          required: true
          schema:
            type: string
      responses:
        '200':
          description: bannerSchema
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bannerSchema'
        '401':
          description: >-
            Authorization information is missing or invalid. Provide a valid API
            token as the `authorization` header, e.g.
            `authorization:*.*.my-admin-token`.
          content: {}
        '403':
          description: >-
            The provided user credentials are valid, but the user does not have
            the necessary permissions to perform this operation
          content: {}
        '404':
          description: The requested resource was not found.
          content: {}
components:
  schemas:
    bannerSchema:
      type: object
      properties:
        id:
          type: integer
          description: >-
            The banner's ID. Banner IDs are incrementing integers. In other
            words, a more recently created banner will always have a higher ID
            than an older one.
        message:
          type: string
          description: The message to display to all users. Supports markdown.
        enabled:
          type: boolean
          description: >-
            Whether the banner should be displayed currently. If not specified,
            defaults to true.
        variant:
          type: string
          description: >-
            The variant of the banner. One of "info", "warning", "error", or
            "success". If not specified, defaults to "info".
        sticky:
          type: boolean
          description: >-
            Whether the banner should be sticky on the screen. If not specified,
            defaults to `false`.
        icon:
          type:
            - string
            - 'null'
          description: >-
            The icon to display on the banner. Can be one of
            https://fonts.google.com/icons. If not specified, this will be the
            default icon for the variant. If "none", no icon will be displayed.
        link:
          type:
            - string
            - 'null'
          description: >-
            The link to display on the banner. Can either be an absolute or a
            relative link (e.g. absolute: "https://example.com" or relative:
            "/admin/service-accounts"). If "dialog", will display a dialog when
            clicked. If not specified, no link will be displayed.
        linkText:
          type:
            - string
            - 'null'
          description: >-
            The text to display on the link. If not specified, will be displayed
            as "More info".
        dialogTitle:
          type:
            - string
            - 'null'
          description: >-
            The title to display on the dialog. If not specified, this will be
            the same as `linkText`.
        dialog:
          type:
            - string
            - 'null'
          description: >-
            The markdown to display on the dialog. If not specified, no dialog
            will be displayed.
        createdAt:
          type: string
          format: date-time
          description: The date and time of when the banner was created.
      required:
        - id
        - message
        - createdAt

```

## SDK Code Examples

```python
import requests

url = "https://app.unleash-instance.example.com/api/admin/banners/id/on"

headers = {"Authorization": "<apiKey>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.unleash-instance.example.com/api/admin/banners/id/on';
const options = {method: 'POST', headers: {Authorization: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.unleash-instance.example.com/api/admin/banners/id/on"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.unleash-instance.example.com/api/admin/banners/id/on")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://app.unleash-instance.example.com/api/admin/banners/id/on")
  .header("Authorization", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.unleash-instance.example.com/api/admin/banners/id/on', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.unleash-instance.example.com/api/admin/banners/id/on");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://app.unleash-instance.example.com/api/admin/banners/id/on")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```