Skip to main content
POST
Create a folder

Authorizations

Authorization
string
header
required

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Scopes

documents:write

Create documents and edit the documents the user created.

Headers

Sajn-Version
enum<string>

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Available options:
2026-09,
2026-10
Sajn-Workspace
string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Body

application/json

Body

name
string
required

Folder name

Minimum string length: 1
type
enum<string>
required

Folder type: DOCUMENT or TEMPLATE

Available options:
DOCUMENT,
TEMPLATE
parentFolderId
string | null

Parent folder to nest under. Omit for a top-level folder.

Response

200

id
string
required

Unique folder identifier

name
string
required

Folder name

type
enum<string>
required

Folder type: DOCUMENT or TEMPLATE

Available options:
DOCUMENT,
TEMPLATE
parentFolderId
string | null
required

Parent folder id, or null for top-level folders

workspaceId
string
required

The workspace ID.

createdBy
object
required

The user who created the folder

createdAt
string<date-time>
required

When the folder was created.

updatedAt
string<date-time>
required

When the folder was last updated.

childFolderCount
integer
required

Number of folders directly in this folder, not counting trashed ones

Required range: -9007199254740991 <= x <= 9007199254740991
itemCount
integer
required

Number of documents or templates directly in this folder that you can see, not counting trashed or archived ones

Required range: -9007199254740991 <= x <= 9007199254740991