Skip to content
FirmEasy
← Inicio

Update Folder

PUT
https://app.firmeasy.legal/api/v1/folders/{{token}}

Update Folder

Section titled “Update Folder”

This endpoint allows updating the metadata of an existing folder.

Where {token} corresponds to the unique identifier of the folder to update.

Headers

Section titled “Headers”

To authorize access to the API, you must include the authentication token in the Authorization header using the Bearer scheme. Additionally, the Content-Type header must specify that the request body (if any) is sent in JSON format.

Authorization
string
Access token obtained during login, with the 'Bearer' prefix.
Limits:Required
Content-Type
string
Format of sent data.
Limits:'application/json'
Required Fields

Fields marked with an asterisk (*) are required and must be provided in the request. Other fields are optional.

Request Body

Section titled “Request Body”

The request body contains the necessary parameters to perform the operation. Fields marked with * are required; the rest are optional depending on each integration’s needs.

name
string
New folder name.
Limits:Required
description
string
Folder description.
Limits:Optional
parent_token
string
If included, it would move the folder under a parent folder with that token.
Limits:Optional
parent_token
string
If you send null, it would remove the parent relationship (making it a root folder).
Limits:Optional

Minimum request example

Section titled “Minimum request example”
{
  "name": "Contrato Horizonte Sur"
  // "description": "Acuerdo para el desarrollo de la plataforma de gestión de datos",
  // "parent_token": "9b71f7a2-13c4-4e1b-9a6f-824f9a8c57d4"
  // "parent_token": null
}

Successful Response

Section titled “Successful Response”
{
  "external_id": "b81f2a39-45cb-4f7f-9132-62c4b29af231",
  "token": "0a9d3c52-83e2-49b0-b6cb-61de52f7ac19",
  "name": "Contrato Río Claro",
  "description": "Acuerdo para la provisión y mantenimiento de equipos de telecomunicaciones",
  "document_count": 2,
  "signed_documents_count": 1,
  "in_progress_documents_count": 1,
  "not_started_documents_count": 0,
  "created_at": "2024-11-12T10:27:14.000000Z",
  "updated_at": "2024-12-05T15:48:03.000000Z",
  "deleted": false,
  "children": [],
  "parent": null
}

Returned Fields

Section titled “Returned Fields”

The service response returns the complete object of the updated folder, including its internal identifier, edited metadata, and the current status of associated documents. The fields included in the response are described below.

external_id
string
External ID assigned by the client.
token
string
Unique internal token assigned by Firmeasy.
name
string
Current folder name.
description
string
Current folder description.
document_count
integer
Total number of documents.
signed_documents_count
integer
Signed documents.
in_progress_documents_count
integer
Documents in progress.
not_started_documents_count
integer
Documents not started.
created_at
datetime
Creation date.
updated_at
datetime
Last modification date.
deleted
boolean
Indicates if it is logically deleted.
children
array
List of subfolders.
parent
object/null
Parent folder (if it exists).

Possible Errors

Section titled “Possible Errors”
Code Description
400 Invalid request (incorrect or missing parameters).
401 Unauthorized (invalid or missing token).
404 Folder not found (invalid token).
500 Unexpected internal error.