---
title: "Update list metadata"
method: PUT
path: "/api/lists/{list_name}"
tags: ["Static Lists"]
---

# Update list metadata

`PUT /api/lists/{list_name}`

## Request

- Base URL: `https://go.urbanairship.com`
- URL: `https://go.urbanairship.com/api/lists/{list_name}`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
  - OAuth 2
    - Client credentials
    - Token URL: `http://oauth2.{domain}.com/token` scopes: `lst`
- TypeScript: <https://skmtc.dev/airship/apis/airship-api/docs/api/lists/:list_name/put.ts> (a function with typed inputs; its response is checked against the schema)

Update the metadata (`description`, `extras`, etc.) of a static list.

## Path parameters

- `list_name` string, required

## Request body

- ListMetadataObject: Contains all user-specified data when defining a static list in Airship.
  - `description` string: An optional description for the list.
  - `extra` unknown
  - `name` string, required: The name of the list, consists of up to 64 URL-safe characters. The name is how the list is identified, so it should be unique and memorable. Note: Since the `name` portion of the URL may represent any Unicode string, it must be encoded properly as a URI path component. The `encodeURIComponent` function in JavaScript can be used.

## Response `200`

The list metadata was updated successfully.

- OkResponseObject: Returned with 2xx Responses. At a minimum, successful calls return `true` for the `ok` key. If your call includes a verbose response (as with `GET` requests, etc.), the `ok` key will appear in the top-most object, outside the verbose response.
  - `ok` boolean, required: Success.
  - `operation_id` string, uuid: A unique string identifying the operations that modify resources. Use the operation ID to locate and track grouped operations (i.e., a batch push operation may generate multiple `push_id` strings, but a single `operation_id`) or operations that change an existing resource.

## Other responses

- `400`: Bad Request. Parsing or validating the request failed. error_code 40001: Attempted list rename. List renaming is not allowed.
- `401`: Authentication information (the app key and secret or bearer token) was either incorrect or missing.
- `403`: Forbidden. Authentication was correct, but the user does not have permission to access the requested API, e.g., the API may not be used to create or modify lists with a `ua_` prefixed name.
- `404`: The requested resource doesn't exist.

---

[API](https://skmtc.dev/airship/apis/airship-api.md) - [All operations](https://skmtc.dev/airship/apis/airship-api/llms.txt) - [OpenAPI document](https://skmtc.dev/airship/apis/airship-api/revisions/bd6ab947117a?raw)