Excluir Modelo
Remove um modelo de forma definitiva. Documentos e envelopes já gerados a partir dele continuam existindo.
Endpoint
DELETE /v1/models/{id}
Headers
| Header | Valor |
|---|---|
| Authorization | Bearer {token} |
Parâmetros de URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string (UUID) | Sim | ID do modelo a ser excluído |
Exemplo de Requisição
curl -X DELETE https://api.tapsign.com.br/v1/models/3f6b2c1e-8d4a-4f7b-9c2e-5a1d0b7e9f10 \
-H "Authorization: Bearer {token}"
Resposta de Sucesso
Status: 204 No Content
A resposta não possui corpo.
Erros
| Código | Quando acontece |
|---|---|
400 | id que não é um UUID válido |
401 | Token ausente ou inválido |
404 | Modelo não encontrado ou de outro usuário |
A exclusão remove o modelo, o arquivo DOCX guardado e, junto com ele, as variáveis, os signatários configurados, os documentos complementares e os registros de preenchimento do modelo. Não há como desfazer.
Cada envelope gerado a partir do modelo tem o próprio PDF, então os envelopes já criados não são afetados. A exclusão só impede a geração de novos documentos com esse modelo.
Desativar em vez de excluir
Se a ideia é só parar de gerar documentos, desative o modelo. A mesma rota alterna o status entre ACTIVE e INACTIVE.
PATCH /v1/models/{id}/status
curl -X PATCH https://api.tapsign.com.br/v1/models/3f6b2c1e-8d4a-4f7b-9c2e-5a1d0b7e9f10/status \
-H "Authorization: Bearer {token}"
A resposta é 200 OK com o modelo atualizado, no formato de Detalhar Modelo. Um modelo INACTIVE é recusado com erro 400 ao gerar documentos, e volta a funcionar quando você chama a rota de novo.