Saltar al contenido principal

Eliminar una plantilla

DELETE/templatellave privadaprk_

Este servicio elimina una plantilla de tu organización: borra su configuración, sus dos HTML —el Mask y el Complete— y los links de referencia que apuntan a ella. Después de eliminarla, la plantilla deja de aparecer en GET /template y ya no se pueden crear procesos con ella.

Auco se niega a eliminarla mientras algún proceso creado con ella siga en firma —sin terminar, sin vencer y sin rechazar—, porque ese proceso todavía necesita la plantilla para armar el PDF firmado. Cuando todos sus procesos terminan, vencen o se rechazan, la puedes eliminar.

La eliminación no se puede deshacer

No hay forma de recuperar una plantilla eliminada, y volver a crearla con POST /template le asigna un id nuevo: las integraciones y los links de referencia que usaban el anterior dejan de funcionar. Si puedes llegar a necesitarla, descárgala antes con GET /template?id=, que devuelve su configuración y las URLs para bajar los dos HTML.


Autenticación​

Incluye tu llave privada en el encabezado Authorization.

Authorization: prk_xxx...

Pasos para eliminar una plantilla:​

  1. Descarga la plantilla con GET /template?id= si puedes llegar a necesitarla.
  2. Llama a DELETE /template con el id de la plantilla.
  3. Si la respuesta es TEMPLATE_IN_USE, espera a que terminen los procesos que siguen en firma, o cancélalos con POST /document/cancel, y vuelve a intentarlo.

Parámetros de consulta​

NombreTipoDescripción
idString requeridoIdentificador de la plantilla, un ObjectId de 24 caracteres hexadecimales.

🧪 Ejemplos de uso​

tip

Puedes copiar cualquiera de los ejemplos según el lenguaje de tu preferencia.

🔹 Eliminar una plantilla por id​

curl --location --request DELETE 'https://api.auco.ai/v1.5/ext/template?id=64823dc5ce28a265e02d68f3' \
--header 'Authorization: prk_private_key_company'

📥 Ejemplos de respuesta​

🔹 Plantilla eliminada​

{
"id": "64823dc5ce28a265e02d68f3",
"deleted": true,
"references": 2
}

🔸 Plantilla con procesos en firma​

{
"message": "TEMPLATE_IN_USE"
}

📋 Campos de la respuesta​

CampoTipoDescripción
idStringIdentificador de la plantilla eliminada, el mismo que enviaste.
deletedBooleantrue: la plantilla y sus dos HTML se eliminaron.
referencesNumberCuántos links de referencia a la plantilla se eliminaron con ella. 0 si no tenía ninguno.

⚠️ Respuestas de error​

CódigoDescripción
400Parámetro inválido o plantilla no eliminable: TEMPLATE_NOT_FOUND (el id no corresponde a una plantilla de tu organización), TEMPLATE_IN_USE (algún proceso creado con la plantilla sigue en firma), o el mensaje del validador si id falta o no es un ObjectId
401Autenticación inválida o ausente

El mensaje del validador describe el problema con id: "id" is required, "id" length must be 24 characters long o "id" must only contain hexadecimal characters.

TEMPLATE_IN_USE no dice cuáles procesos

La respuesta no identifica los procesos que bloquean la eliminación. Si necesitas saberlo, revisa en tu integración los procesos que creaste con esa plantilla y consulta su estado con GET /document.