🍿 @lorenzopant/tmdb

Update

Update a v4 list's metadata — name, description, visibility, or sort order.

Updates one or more metadata fields on an existing list. Only pass the fields you want to change; omitted fields are left unchanged.

async update(body: V4UpdateListBody): Promise<V4ListStatusResponse>

TMDB Reference: Update List

Parameters

NameTypeRequiredDescription
list_idnumberThe TMDB list ID to update.
namestringNew display name.
descriptionstringNew description text.
publicbooleanChange the visibility of the list.
sort_bystringSort field and direction. Examples: "original_order.asc", "vote_average.desc", "primary_release_date.desc".

Returns

V4ListStatusResponse

Errors

HTTPTMDB codeCause
4013Invalid or missing access token.
40434List not found.
40315Not authorized to modify this list.

Example

import { TMDB } from "@lorenzopant/tmdb";

const tmdb = new TMDB("your-access-token");

await tmdb.v4.lists.update({
	list_id: 8700,
	name: "My Updated Watchlist",
	public: true,
	sort_by: "vote_average.desc",
});

On this page