Actualizar Carpeta

PUT {{base_url}}/v1/folders/{{token}}

Actualizar Carpeta

Este endpoint permite actualizar los metadatos de una carpeta existente.

Donde {{token}} corresponde al identificador único de la carpeta a actualizar.

Headers

Para autorizar el acceso a la API es necesario incluir el token de autenticación en el encabezado Authorization, utilizando el esquema Bearer. Además, el encabezado Content-Type debe especificar que el cuerpo de la solicitud (si lo hubiera) se envía en formato JSON.

Parámetro	Tipo	Descripción	Límites
`Authorization*`	string	Token de acceso obtenido en el login, con el prefijo 'Bearer'.	Obligatorio
`Content-Type`	string	Formato de datos enviados.	'application/json'

Campos Obligatorios

Los campos marcados con un asterisco (*) son obligatorios y deben ser proporcionados en la solicitud. Los demás campos son opcionales.

Cuerpo de la solicitud

En el cuerpo de la solicitud se envían los parámetros necesarios para realizar la operación. Los campos marcados con * son obligatorios; los demás son opcionales según las necesidades de cada integración.

Parámetro	Tipo	Descripción	Límites
`name*`	string	Nuevo nombre de la carpeta.	Obligatorio
`description`	string	Descripción de la carpeta.	Opcional
`parent_token`	string	Si lo incluyeras, movería la carpeta bajo una carpeta padre con ese token.	Opcional
`parent_token`	string	Si enviaras null, quitarías la relación de padre (la dejarías como carpeta raíz).	Opcional

Ejemplo mínimo de request

{
  "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
}

Respuesta exitosa

{
  "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
}

Campos devueltos

La respuesta del servicio devuelve el objeto completo de la carpeta actualizada, incluyendo su identificador interno, los metadatos editados y el estado actual de los documentos asociados. A continuación se describen los campos incluidos en la respuesta.

Nombre	Tipo	Descripción
`external_id`	string	ID externo asignado por el cliente.
`token`	string	Token interno único que es asignado por Firmeasy.
`name`	string	Nombre actual de la carpeta.
`description`	string	Descripción actual de la carpeta.
`document_count`	integer	Cantidad total de documentos.
`signed_documents_count`	integer	Documentos firmados.
`in_progress_documents_count`	integer	Documentos en progreso.
`not_started_documents_count`	integer	Documentos no iniciados.
`created_at`	datetime	Fecha de creación.
`updated_at`	datetime	Fecha de última modificación.
`deleted`	boolean	Indica si está eliminada lógicamente.
`children`	array	Lista de subcarpetas.
`parent`	object/null	Carpeta padre (si existe).

Errores posibles

Código	Descripción
400	Request inválido (parámetros incorrectos o faltantes).
401	No autorizado (token inválido o ausente).
404	Carpeta no encontrada (token inválido).
500	Error interno inesperado.