Skip to main content
PATCH
Rename, move or re-own a folder

Authorizations

X-API-Key
string
header
required

Path Parameters

folder_id
string<uuid>
required

Body

application/json

Request body for renaming, moving or re-owning a folder (omitted fields stay).

name

Its new name.

Required string length: 1 - 255
owner_user_id

The workspace member who owns it from now on; null for no owner.

Required string length: 1 - 64
parent_id

The folder to move it into; null for the top level.

Response

Successful Response

A workspace folder, as the Tables list draws it.

created_at
string<date-time>
required
id
string<uuid>
required
name
string
required
owner_user_id
string | null
required

Who to ask about it: whoever made it, unless somebody changed it.

parent_id
string<uuid> | null
required

The folder it sits in; null for the top level.

updated_at
string<date-time>
required
folder_count
integer
default:0

Folders directly in it.

last_viewed_at
string<date-time> | null

When the CALLING USER last opened any table in it, at any depth; null when they never have.

nested_archived_count
integer
default:0

Archived tables in it at any depth, which go to Trash with it too.

nested_table_count
integer
default:0

Tables in it at any depth, archived ones aside. What deleting it would send to Trash, archived tables added.

owner_display_name
string | null

The owner's name, resolved for display.

table_count
integer
default:0

Tables directly in it, archived ones aside.