POST

Create a subfolder

https://www.helprange.com/api/v2/folders/{folder_id}/subfolders

Creates a subfolder in a folder. Refused with 400 while subfolders are off for the folder (turn them on with Turn subfolders on or off).

Plans: Max, Unlimited, Deal Room Pass, trial. Auth: Authorization: Bearer hr_live_… (team key), X-API-Key, Authorization: Api-Key <key> or an OAuth Bearer token. Scope: documents:write. Operation id: createSubfolder

Parameters

NameInTypeDescription
folder_id requiredpathintegerFolder id (from List folders). (min 1)

Request body

Content types: application/json, application/x-www-form-urlencoded.

FieldTypeDescription
name requiredstringSubfolder name. (max length 100)

Example request

curl -X POST https://www.helprange.com/api/v2/folders/31/subfolders \
  -H "X-API-Key: $HELPRANGE_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-binary '{"name": "Contracts"}'

The samples read the key from the HELPRANGE_API_KEY environment variable.

Responses

StatusDescription
201Created
400Invalid input – the message says which parameter.
401Missing or invalid API key / OAuth token. Team keys: code invalid_key, key_revoked, key_expired or key_owner_removed.
402Your plan does not include the REST API (or this feature).
403The team API key lacks the scope this endpoint needs.
404Not found – or not yours (the API never says which).
405Wrong HTTP method for this endpoint.
429A usage limit was reached – wait Retry-After seconds.
Example response · 201
{
  "id": 7,
  "name": "Contracts",
  "position": 0,
  "folder_id": 31,
  "documents_count": 0,
  "folder": "Legal"
}

Try it

Uses your real account. The request goes from your browser straight to www.helprange.com with your API key and acts as you – this POST changes data. The key stays in this page (in this tab's session storage only if you tick the box), is never put in a URL and is not sent to analytics. Do not paste a key on a shared computer.