Skip to main content
PATCH
Update a list

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Path Parameters

listId
string
required

The list's id.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$

Body

application/json
name
string

A new name.

Required string length: 1 - 255
folderId
string

Move the list into this folder, one for the list's own kind, or out of every folder with null.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$
folderName
string

Move the list into the folder of this name, in any case, which is created when the list's kind has none. Send this or folderId, not both.

Required string length: 1 - 120

Response

What changed: the list's new name, its new folder, or both.

id
string
required
name
string

The new name, when it changed.

folderId
string | null

The folder the list moved to, when it moved: null when it moved out of every folder.