> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gleap.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a banner

> Update an engagement banner. Any pending (not yet sent) deliveries for this engagement are discarded
and re-queued from the updated document. While an engagement is live, its audience, targeting and
scheduling fields cannot be changed (for `fixed` frequency engagements neither can its content); pause
it first or the request fails with 409. Setting `status` to `live` starts delivery. `type`, `project`,
`organisation` and `createdBy` are set server-side and ignored if supplied.



## OpenAPI

````yaml https://api.gleap.io/api-docs.json put /engagement/banners/{bannerId}
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /engagement/banners/{bannerId}:
    put:
      tags:
        - Engagement Banner
      summary: Update a banner
      description: >-
        Update an engagement banner. Any pending (not yet sent) deliveries for
        this engagement are discarded

        and re-queued from the updated document. While an engagement is live,
        its audience, targeting and

        scheduling fields cannot be changed (for `fixed` frequency engagements
        neither can its content); pause

        it first or the request fails with 409. Setting `status` to `live`
        starts delivery. `type`, `project`,

        `organisation` and `createdBy` are set server-side and ignored if
        supplied.
      operationId: UpdateBanner
      parameters:
        - in: path
          name: bannerId
          required: true
          schema:
            type: string
        - in: header
          name: project
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema: {}
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema: {}
      security:
        - jwt: []
components:
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT

````