Lists

Rename a list or move it between folders

Renames the list and/or moves it between folders. name must stay unique in the workspace (409 LIST_NAME_TAKEN). folderId moves the list into an existing folder of its own kind — an unknown id, a folder of another workspace, or one holding the other kind of list all answer 404 FOLDER_NOT_FOUND; folderId: null returns it to the root; folderName is create-or-reuse by exact, case-insensitive name for the list's kind (mutually exclusive with folderId). A move is only reported when it actually happened: a list that is not the token owner's to move answers 404 LIST_NOT_FOUND, and moving a list into the folder it is already in is a no-op that still answers 200. The response echoes only the fields that changed.

Errors:

  • 404 LIST_NOT_FOUND — No list with that id is visible to the token owner, or the list is not theirs to move.
  • 404 FOLDER_NOT_FOUND — folderId does not name a folder of the token owner that holds lists of this list's kind.
  • 409 LIST_NAME_TAKEN — Another list already has the requested name.
  • 422 VALIDATION_FAILED — No field to change, both folderId and folderName sent, or a value out of bounds.
  • 429 RATE_LIMITED — The lists rate bucket is exhausted.

Requires one of the following token scopes: lists.

patch/business/lists/{listId}

Request

  • Base URL: https://api.tryfuse.ai/api/v1
  • URL: https://api.tryfuse.ai/api/v1/business/lists/{listId}
  • Auth: HTTP basic

Path parameters

listIdstring required

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

Request body

namestring

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

folderIdstring nullable

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.

folderNamestring

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.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.