Skip to main content
PATCH
Rename a list or move it between folders

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Path Parameters

listId
string
required

24-character hex id of the list (from GET /business/lists).

Body

application/json
name
string

New list name (1-255 characters, trimmed); must be unique in the workspace or the call answers 409 LIST_NAME_TAKEN.

Required string length: 1 - 255
folderId
string | null

Move the list into this folder (24-character hex id of a folder of the list's own kind); null removes it from its current folder, and an unknown id answers 404 FOLDER_NOT_FOUND.

folderName
string

Move the list into the folder with this exact name (case-insensitive, 1-120 characters), creating it for the list's kind when none exists; mutually exclusive with folderId.

Required string length: 1 - 120

Response

Success

list
object
required