Skip to main content
POST
Create a folder

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Body

application/json
name
string
required
scope
string
required

private | team | channel.

channel_id
string<uuid> | null

Required iff scope='channel'; the caller must be a member.

parent_id
string<uuid> | null

Parent folder (same scope). Omit / null for a root folder.

Response

Created folder

created_at
string<date-time>
required
doc_count
integer<int64>
required

Live documents directly in this folder.

id
string<uuid>
required
is_owner
boolean
required
name
string
required
owner_user_id
string<uuid>
required
scope
string
required
updated_at
string<date-time>
required
channel_id
string<uuid> | null
channel_name
string | null
parent_id
string<uuid> | null