Skip to main content

DELETE Excluir Versão do Modelo

Tira uma versão do histórico (exclusão lógica). A versão em uso não pode ser excluída: ative outra ou volte ao padrão antes.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão delete_document_templates.


Endpoint​

DELETE https://api-dev.imagemais.com.br/api/document-templates/{type}/versions/{version}

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
typestring✅Tipo do documento: LETTERHEAD, PRESCRIPTION, EXAMS, REFERRAL, MEDICAL_CERTIFICATE, DECLARATION, LIFESTYLE_ADVICE, APPOINTMENT_RECEIPT, PROCEDURE_REFERRAL, BUDGET, COLLECTION_RECEIPT, STANDALONE_DECLARATION, RAPID_TEST_HISTORY
versionnumber✅Número da versão

Requisição​

curl -X 'DELETE' \
'https://api-dev.imagemais.com.br/api/document-templates/PRESCRIPTION/versions/2' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

204 Sem conteúdo​

Resposta sem corpo.

400 Requisição inválida​

Mensagem possível, além das de tipo ou versão inválidos:

  • Esta versão está em uso. Use outra versão ou volte ao padrão antes de excluí-la.
{
"message": "Esta versão está em uso. Use outra versão ou volte ao padrão antes de excluí-la.",
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

404 Não encontrado​

{
"message": "Versão do modelo não encontrada",
"error": "Not Found",
"statusCode": 404
}