Skip to Content
HelvetlyDocs
API referenceDocuments

Create a document folder

Needs a token with the write:documents scope. Authentication

Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.

POST
/api/v1/documents/folders

Creates a folder (name, optional parent_id). Names are unique among live siblings, case-insensitively: 409 name_taken with details {existing_id, suggestion}. 422 validation_failed for a bad name or a parent that does not exist. Not idempotent: a retry answers 409 name_taken.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A personal API token, hvt_…, with scopes such as read:* or write:invoices

Request Body

application/json
  1. body
name*string

Unique among live sibling folders (case-insensitive); no / or \ or control characters.

Length1 <= length <= 255
parent_id?|

A live folder; null or absent: top level.

Response Body

Created

application/json
  1. response
data*
Example Request
curl -X POST 'https://app.helvetly.com/api/v1/documents/folders' \  -H 'Content-Type: application/json' \  -d '{  "name": "Contracts 2026",  "parent_id": null}'
Example Response
{  "data": {    "id": "string",    "name": "string",    "parent_id": "string",    "file_count": 0,    "size": 0,    "total_files": 0,    "total_size": 0,    "created_by": {      "id": "string",      "name": "string"    },    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "starred": true  }}

List document folders

Previous Page

Rename or move a document folder

Next Page