Excluir um modelo

DELETE/templatechave privadaprk_

Este serviço exclui um modelo da sua organização: apaga sua configuração, seus dois arquivos HTML —a Máscara e o Completo— e os links de referência que apontam para ele. Depois de excluído, o modelo deixa de aparecer em GET /template e não é mais possível criar processos com ele.

A Auco se recusa a excluí-lo enquanto houver algum processo criado a partir dele ainda em assinatura —não finalizado, não expirado e não rejeitado—, porque esse processo ainda precisa do modelo para gerar o PDF assinado. Quando todos os seus processos forem finalizados, expirarem ou forem rejeitados, você poderá excluí-lo.

A exclusão não pode ser desfeita

Não há como recuperar um modelo excluído, e criá-lo novamente com POST /template lhe atribui um novo id: as integrações e os links de referência que usavam o anterior deixam de funcionar. Se você puder precisar dele novamente, baixe-o antes com GET /template?id=, que retorna sua configuração e as URLs para baixar os dois arquivos HTML.

---

Autenticação

Inclua sua chave privada no cabeçalho Authorization.

Authorization: prk_xxx...

---

Passos para excluir um modelo:

1. Baixe o modelo com GET /template?id= se puder precisar dele novamente.
2. Chame DELETE /template com o id do modelo.
3. Se a resposta for TEMPLATE_IN_USE, aguarde os processos ainda em assinatura serem finalizados, ou cancele-os com POST /document/cancel, e tente novamente.

---

Parâmetros de consulta

Nome	Tipo	Descrição
id	String obrigatório	Identificador do modelo, um ObjectId de 24 caracteres hexadecimais.

---

🧪 Exemplos de uso

dica

Você pode copiar qualquer um dos exemplos de acordo com a sua linguagem preferida.

🔹 Excluir um modelo por id

curl

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

Python

import requests

response = requests.delete(
  "https://api.auco.ai/v1.5/ext/template",
  headers={"Authorization": "prk_private_key_company"},
  params={"id": "64823dc5ce28a265e02d68f3"}
)
print(response.json())

Node.js

const axios = require('axios');

axios
  .delete('https://api.auco.ai/v1.5/ext/template', {
    headers: { Authorization: 'prk_private_key_company' },
    params: { id: '64823dc5ce28a265e02d68f3' },
  })
  .then((response) => console.log(response.data));

---

📥 Exemplos de respostas

🔹 Modelo excluído

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

🔸 Modelo com processos em assinatura

{
  "message": "TEMPLATE_IN_USE"
}

---

📋 Campos da resposta

Campo	Tipo	Descrição
id	String	Identificador do modelo excluído, o mesmo que você enviou.
deleted	Boolean	true: o modelo e seus dois arquivos HTML foram excluídos.
references	Number	Quantos links de referência ao modelo foram excluídos junto com ele. 0 se não tinha nenhum.

---

⚠️ Respostas de erro

Código	Descrição
400	Parâmetro inválido ou modelo que não pode ser excluído: TEMPLATE_NOT_FOUND (o id não corresponde a um modelo da sua organização), TEMPLATE_IN_USE (um processo criado a partir do modelo ainda está em assinatura), ou a mensagem do validador se id estiver ausente ou não for um ObjectId
401	Autenticação inválida ou ausente

A mensagem do validador descreve o problema com id: "id" is required, "id" length must be 24 characters long ou "id" must only contain hexadecimal characters.

TEMPLATE_IN_USE não diz quais processos

A resposta não identifica os processos que bloqueiam a exclusão. Se você precisar saber, verifique na sua integração os processos que criou com esse modelo e consulte o status deles com GET /document.