Aller au contenu principal

Supprimer un modèle

DELETE/templateclé privéeprk_

Ce service supprime un modèle de votre organisation : il efface sa configuration, ses deux fichiers HTML —le Masque et le Complet— ainsi que les liens de référence qui pointent vers lui. Une fois supprimé, le modèle n'apparaît plus dans GET /template et aucun processus ne peut plus être créé avec lui.

Auco refuse de le supprimer tant qu'un processus créé à partir de celui-ci est encore en cours de signature —ni terminé, ni expiré, ni rejeté—, car ce processus a encore besoin du modèle pour générer le PDF signé. Une fois que tous ses processus sont terminés, expirés ou rejetés, vous pouvez le supprimer.

La suppression est irréversible

Il est impossible de récupérer un modèle supprimé, et le recréer avec POST /template lui attribue un nouvel id : les intégrations et les liens de référence qui utilisaient l'ancien cessent de fonctionner. Si vous pensez en avoir de nouveau besoin, téléchargez-le d'abord avec GET /template?id=, qui retourne sa configuration et les URL permettant de télécharger ses deux fichiers HTML.


Authentification​

Incluez votre clé privée dans l'en-tête Authorization.

Authorization: prk_xxx...

Étapes pour supprimer un modèle :​

  1. Téléchargez le modèle avec GET /template?id= si vous pensez en avoir de nouveau besoin.
  2. Appelez DELETE /template avec l'id du modèle.
  3. Si la réponse est TEMPLATE_IN_USE, attendez que les processus encore en cours de signature se terminent, ou annulez-les avec POST /document/cancel, puis réessayez.

Paramètres de requête​

NomTypeDescription
idString obligatoireIdentifiant du modèle, un ObjectId de 24 caractères hexadécimaux.

🧪 Exemples d'utilisation​

astuce

Vous pouvez copier l'un des exemples selon votre langage préféré.

🔹 Supprimer un modèle par id​

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

📥 Exemples de réponses​

🔹 Modèle supprimé​

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

🔸 Modèle avec des processus en cours de signature​

{
"message": "TEMPLATE_IN_USE"
}

📋 Champs de la réponse​

ChampTypeDescription
idStringIdentifiant du modèle supprimé, le même que celui que vous avez envoyé.
deletedBooleantrue : le modèle et ses deux fichiers HTML ont été supprimés.
referencesNumberNombre de liens de référence vers le modèle supprimés avec lui. 0 s'il n'en avait aucun.

⚠️ Réponses d'erreur​

CodeDescription
400Paramètre invalide ou modèle ne pouvant pas être supprimé : TEMPLATE_NOT_FOUND (l'id ne correspond à aucun modèle de votre organisation), TEMPLATE_IN_USE (un processus créé à partir du modèle est encore en cours de signature), ou le message du validateur si id est absent ou n'est pas un ObjectId
401Authentification invalide ou absente

Le message du validateur décrit le problème lié à id : "id" is required, "id" length must be 24 characters long ou "id" must only contain hexadecimal characters.

TEMPLATE_IN_USE n'indique pas quels processus

La réponse n'identifie pas les processus qui bloquent la suppression. Si vous avez besoin de le savoir, vérifiez dans votre intégration les processus que vous avez créés avec ce modèle et consultez leur statut avec GET /document.