Skip to main content

POST Criar Modelo de Declaração

Cria um modelo (máscara) de declaração para a conta.

Autenticação necessária

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

Sem permissão específica

Não exige @CheckPermissions — basta estar autenticado.


Endpoint​

POST https://api-dev.imagemais.com.br/api/declaration-template/create

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
namestring✅não vazio; até 200 caracteresNome da máscara cadastrada
descriptionstring❌até 500 caracteresDescrição da máscara cadastrada
contentstring✅não vazio; até 50000 caracteresConteúdo da máscara cadastrada
isActiveboolean❌—Se a máscara está ativa

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/declaration-template/create' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Exemplo",
"description": "Descrição de exemplo",
"content": "Conteúdo de exemplo",
"isActive": true
}'

Respostas​

201 Sucesso​

{
"id": 2,
"name": "TESTE DOC",
"description": "Modelo criado pela documentação",
"content": "<p>Declaro que {{paciente}} esteve em atendimento.</p>",
"isActive": false,
"accountId": 1,
"createdAt": "2026-09-30T18:48:30.083Z",
"updatedAt": "2026-09-30T18:48:30.083Z",
"deletedAt": null
}

400 Requisição inválida​

Retornado quando o corpo ou a query não passam na validação. A lista message traz um item por regra violada, por exemplo:

{
"message": [
"name must be shorter than or equal to 200 characters",
"name should not be empty",
"name must be a string",
"content must be shorter than or equal to 50000 characters",
"content must be longer than or equal to 1 characters",
"content should not be empty",
"content must be a string"
],
"error": "Bad Request",
"statusCode": 400
}