Skip to main content

POST Criar Modelo de Encaminhamento

Cria um modelo de encaminhamento: o local para onde o paciente é encaminhado, com endereço, telefone, logo e rodapé impressos no documento.

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/referrals/create

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
namestring✅não vazio; até 200 caracteresNome interno do template de encaminhamento
locationNamestring✅não vazio; até 200 caracteresNome do local exibido no documento impresso
addressstring✅não vazio; até 500 caracteresEndereço completo do local
phonestring✅não vazio; até 200 caracteresTelefone(s) de contato do local
logoUrlstring❌até 500 caracteresURL do logo do local (Cloudflare R2)
footerTextstring❌até 2000 caracteresTexto customizado do rodapé

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/referrals/create' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Exemplo",
"locationName": "Clínica Exemplo",
"address": "Rua Exemplo, 100",
"phone": "81999999999",
"logoUrl": "https://exemplo.com.br/arquivo.pdf",
"footerText": "texto"
}'

Respostas​

201 Sucesso​

{
"id": 1,
"name": "Nome Exemplo",
"locationName": "Clínica Parceira Exemplo",
"address": "Rua Exemplo, 100",
"phone": "(81) 99999-9999",
"logoUrl": null,
"footerText": "Rodapé de exemplo.",
"accountId": 1,
"createdAt": "2026-09-30T18:48:30.394Z",
"updatedAt": "2026-09-30T18:48:30.394Z",
"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",
"locationName must be shorter than or equal to 200 characters",
"locationName should not be empty",
"locationName must be a string",
"address must be shorter than or equal to 500 characters",
"address should not be empty",
"address must be a string",
"phone must be shorter than or equal to 200 characters",
"phone should not be empty",
"phone must be a string"
],
"error": "Bad Request",
"statusCode": 400
}