Update list metadata

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

put/api/lists/{list_name}

Request

Base URL
https://go.urbanairship.com
Auth
- HTTP basic
- or HTTP bearer
- or OAuth 2
  Client credentials
  Token URLhttp://oauth2.{domain}.com/token
  Scopeslst
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.

Path parameters

list_namestring required

The name of the list.

Request body

descriptionstring

An optional description for the list.

extraunknown

namestring 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

The list metadata was updated successfully.

okboolean required

Success.

operation_idstring 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.

Changes

No recorded changes to this operation across all 9 revisions of this API.