FAfactorialhr
Documents > Folder

Updates a Folder

Changed on

Update a folder.

put/api/2026-10-01/resources/documents/folders/{id}

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/documents/folders/{id}
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: documents
    • or API key in header x-api-key

Path parameters

idstring required

Folder id

Request body

company_idstring required

Company ID

idstring required

Folder id

namestring required

Folder name

Example request

{
  "company_id": "1",
  "id": "3",
  "name": "New folder name"
}

Response

OK

activeboolean required

Whether the folder is active or not

company_idstring

Company ID of the folder

idstring required

Folder ID

namestring required

Folder name

parent_folder_idstring

Id of the parent folder

spacestring required

The space of the folder is related to the place where the folder is displayed.

Example response

{
  "active": true,
  "company_id": "1",
  "id": "10",
  "name": "Payslips",
  "parent_folder_id": "23"
}

Changes