Skip to main content

POST Criar Bloqueio de Agenda da Clínica

Bloqueia o período na agenda de todos os médicos ativos da conta, em uma transação (tudo ou nada). Recusa tudo se algum médico já tem bloqueio sobreposto ou agendamentos ativos no período.

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


Endpoint​

POST https://api-dev.imagemais.com.br/api/schedule-blocks/batch

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
startDatestring✅data ISO 8601Data inicial do bloqueio
endDatestring✅data ISO 8601Data final (a mesma de startDate bloqueia um único dia)
startTimestring❌formato HH:mmHorário de início (omita junto com endTime para bloquear o dia inteiro)
endTimestring❌formato HH:mmHorário de fim (omita junto com startTime para bloquear o dia inteiro)
reasonstring❌até 255 caracteresMotivo do bloqueio

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/schedule-blocks/batch' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"startDate": "2026-12-24",
"endDate": "2026-12-24",
"reason": "Recesso de fim de ano"
}'

Respostas​

201 Sucesso​

{
"data": [
{
"id": 7,
"doctorId": 4,
"accountId": 1,
"startDate": "2026-12-24T00:00:00.000Z",
"endDate": "2026-12-24T00:00:00.000Z",
"startTime": null,
"endTime": null,
"reason": "Recesso de fim de ano",
"createdAt": "2026-11-10T14:00:00.000Z",
"updatedAt": "2026-11-10T14:00:00.000Z",
"deletedAt": null
},
{
"id": 7,
"doctorId": 5,
"accountId": 1,
"startDate": "2026-12-24T00:00:00.000Z",
"endDate": "2026-12-24T00:00:00.000Z",
"startTime": null,
"endTime": null,
"reason": "Recesso de fim de ano",
"createdAt": "2026-11-10T14:00:00.000Z",
"updatedAt": "2026-11-10T14:00:00.000Z",
"deletedAt": null
}
]
}

data traz um bloqueio por médico ativo.

400 Requisição inválida​

Mensagens possíveis, além das de validação dos campos:

  • A data final do bloqueio não pode ser anterior à data inicial
  • Informe startTime e endTime juntos, ou nenhum dos dois para bloquear o dia inteiro
  • startTime deve ser anterior a endTime
  • A clínica não possui médicos ativos para bloquear a agenda
  • Já existe um bloqueio cadastrado que se sobrepõe a este período para: {médicos} — neste caso o corpo traz também doctors, com doctorId e doctorName de cada médico
{
"message": "Já existe um bloqueio cadastrado que se sobrepõe a este período para: Nome Exemplo",
"doctors": [
{
"doctorId": 4,
"doctorName": "Nome Exemplo"
}
],
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

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

409 Conflito​

Existem agendamentos ativos no período. O corpo traz os conflicts de todos os médicos:

{
"message": "Não é possível bloquear: existem agendamentos ativos neste período. Cancele ou remaneje-os antes de bloquear a agenda.",
"conflicts": [
{
"id": 901,
"doctorId": 4,
"doctorName": "Nome Exemplo",
"date": "2026-12-24T00:00:00.000Z",
"startTime": "08:00",
"endTime": "08:30",
"patientName": "Nome Exemplo"
}
],
"error": "Conflict",
"statusCode": 409
}

500 Erro interno​

{
"message": "Erro ao criar bloqueio de agenda da clínica",
"error": "Internal Server Error",
"statusCode": 500
}