Skip to main content
POST
Cancelar um agendamento

Authorizations

Authorization
string
header
required

Chave de API no formato bd_live_xxxxxxxx.xxxx...

Path Parameters

public_id
string
required
Pattern: ^[0-9a-fA-F-]{36}$

Response

200 - 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