---
title: "Update an existing app banner by ID"
method: PUT
path: "/api/v1/app-banners/{id}"
tags: ["App Banners"]
---

# Update an existing app banner by ID

`PUT /api/v1/app-banners/{id}`

Required scope - write_app

## Path parameters

- `id` number, required

## Request body

- PutAppBannerReq
  - `type` string
  - `text` string
  - `locales` object[]
    - `locale` string, required
    - `value` string, required
  - `appIds` number[]
  - `isActive` boolean

## Response `200`

- object
  - `appBanner` AppBanner
    - `id` number, required
    - `type` string, required
    - `text` string, required
    - `isActive` boolean, required
    - `locales` object[], required
      - `locale` string, required
      - `value` string, required
    - `createdAt` string, required
    - `updatedAt` string, required
    - `deletedAt` string, nullable, required
    - `appIds` number[], required

## Changes

- **2025-08-13** `5ad1a47c235e` — 10 breaking, 1 info
  - the `appBanner` response's property type changed from `object` to no type for status `200`
  - removed the required property `appBanner/appIds` from the response with the `200` status
  - removed the required property `appBanner/createdAt` from the response with the `200` status
  - removed the required property `appBanner/deletedAt` from the response with the `200` status
  - …7 more
- **2025-08-06** `281aa1d0b14d` — 1 info
  - endpoint added
- **2024-08-11** `11e2773b3a1e` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/valuemelody/apis/melody-auth-s2s-api/changes/api/v1/app-banners/:id/put.md)

---

[API](https://skmtc.dev/valuemelody/apis/melody-auth-s2s-api.md) · [All operations](https://skmtc.dev/valuemelody/apis/melody-auth-s2s-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/valuemelody/melody-auth-s2s-api/revisions/2e1471620fd7/schema)