Skip to content

Update List Folder

PATCH
/lists/folders/{folder_id}

Rename a folder or change its visibility. Omitted fields are untouched.

Authorizations

Parameters

Path Parameters

folder_id
required

Folder id.

string format: uuid

Folder id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Either field may be changed independently; omit a field to leave it.

object
title
Any of:
string
>= 1 characters <= 120 characters
visibility
Any of:
string
Allowed values: private org

Responses

200

Successful Response

object
data
required

A folder a developer can group lists into.

object
created_at
Any of:
string format: date-time
created_by
required

User id that created the folder.

string
id
required

Folder id.

string format: uuid
is_owner
required

True when the calling key’s org owns the folder.

boolean
list_count
required

Number of lists currently filed in this folder.

integer
title
required

Display title.

string
updated_at
Any of:
string format: date-time
visibility
required

private (owner only) or org (browse-only for teammates).

string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string