Skip to main content

POST Salvar Modelo

Salva o modelo de um tipo: cria a versão seguinte, que passa a valer, e desativa a que estava em uso. Recusa modelo sem os blocos obrigatórios do tipo (ver Visão Geral).

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 update_document_templates.


Endpoint​

POST https://api-dev.imagemais.com.br/api/document-templates/{type}

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

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
schemaobject✅objeto; esperado { basePdf, schemas } do pdfme, com schemas uma lista não vazia de páginas e cada bloco com name e type em textoTemplate do pdfme

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/document-templates/PRESCRIPTION' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"schema": {
"basePdf": {
"width": 210,
"height": 297,
"padding": [
58,
20,
80,
20
]
},
"schemas": [
[
{
"name": "itens",
"type": "table"
}
]
]
}
}'

Respostas​

201 Sucesso​

{
"type": "PRESCRIPTION",
"version": 4,
"active": true,
"createdAt": "2026-11-10T14:00:00.000Z",
"createdBy": {
"id": 12,
"name": "Nome Exemplo"
},
"schema": {
"basePdf": {
"width": 210,
"height": 297,
"padding": [
58,
20,
80,
20
]
},
"schemas": [
[
{
"name": "itens",
"type": "table"
}
]
]
}
}

400 Requisição inválida​

Mensagens possíveis:

  • schema must be an object
  • Modelo inválido: esperado o template do pdfme com { basePdf, schemas }
  • O modelo precisa ter: bloco "itens" (lista o que falta, incluindo as variáveis do papel timbrado, ex.: {titulo})
  • Validation failed (enum string is expected) (tipo inválido)
{
"message": "O modelo precisa ter: bloco \"itens\"",
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

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

409 Conflito​

{
"message": "O modelo foi salvo por outra pessoa agora há pouco. Recarregue e tente de novo.",
"error": "Conflict",
"statusCode": 409
}