Skip to main content
POST
Criar um agendamento

Authorizations

Authorization
string
header
required

Chave de API no formato bd_live_xxxxxxxx.xxxx...

Headers

Idempotency-Key
string

Chave opcional (até 255 caracteres) que torna a criação idempotente: repetir a mesma requisição com a mesma chave em até 24 horas devolve o registro já criado, com o cabeçalho Idempotent-Replayed: true, em vez de criar outro. A mesma chave com um corpo diferente, ou em outro endpoint, responde 422.

Body

Corpo para criar um agendamento. O agendamento nasce presencial, com status: "scheduled" e origin: "api", no tipo informado e com o pagador Particular do profissional; o valor vem da tabela de preços da clínica.

appointment_type_id
integer
required

id de um tipo de atendimento ativo da clínica (GET /appointment-types).

patient_id
integer
required

patient.id de um paciente ativo da clínica.

professional_id
integer
required

professional.id de um profissional ativo da clínica que atende pacientes.

start_at
string<date-time>
required

Início do atendimento, ISO 8601. Sem fuso horário, é lido em America/Sao_Paulo. Os segundos devem ser 00.

note
string

Observação interna do agendamento, até 2000 caracteres.

Maximum string length: 2000
room_id
integer | null

room.id de uma sala ativa. Omitido, usa a sala padrão da grade do profissional, se houver.

Response

201 - application/json
appointment_type
object
required

Tipo de atendimento do agendamento, como "Consulta" ou "Retorno".

created_at
string<date-time>
required
read-only
end_at
string<date-time>
required
read-only
id
string<uuid> | null
required
read-only
modality
enum<string>
required
  • in_person - Presencial
  • telehealth - Teleconsulta
Available options:
in_person,
telehealth
origin
enum<string>
required
  • staff - Equipe
  • patient_booking - Agendamento online
  • api - API pública
Available options:
staff,
patient_booking,
api
patient
object | null
required

Paciente do agendamento.

professional
object | null
required

Profissional responsável pelo atendimento.

room
object | null
required

Sala em que o atendimento acontece, quando a clínica usa salas.

start_at
string<date-time>
required
read-only
status
enum<string>
required

One of: requested, scheduled, confirmed, checked_in, completed, no_show, cancelled.

Available options:
requested,
scheduled,
confirmed,
checked_in,
completed,
no_show,
cancelled
updated_at
string<date-time>
required
read-only