Cancela una cita de su organización, sin importar el canal con el que se agendó. Se cancelan los recordatorios pendientes y se notifica a los profesionales de salud asignados. Al paciente solo se le notifica cuando notifyPatient es true, según la configuración de notificaciones de cancelación de su clínica (correo, WhatsApp, SMS); por defecto no se le envía nada. Cancelar una cita ya cancelada la devuelve sin cambios, así que los reintentos son seguros. Las citas completadas o marcadas como inasistencia no se pueden cancelar. Requiere una clave de API con permiso de escritura.
Ejemplos de código
Node.js
const fetch = require('node-fetch');
async function llamarApi() {
const claveApi = 'YOUR_API_KEY';
const url = `https://account.lunahealth.app/api/appointments/{id}/cancel`;
const requestBody = {
// Agregue sus datos del cuerpo de la solicitud aquí
};
try {
const response = await fetch(url, {
method: 'POST',
headers: {
'Authorization': `Bearer ${claveApi}`,
'Content-Type': 'application/json'
},
body: JSON.stringify(requestBody)
});
if (!response.ok) {
throw new Error(`API error: ${response.status}`);
}
const data = await response.json();
console.log(data);
return data;
} catch (error) {
console.error('Error al llamar a la API:', error);
throw error;
}
}
llamarApi();
Python
import requests
def llamarApi():
claveApi = 'YOUR_API_KEY'
url = 'https://account.lunahealth.app/api/appointments/{id}/cancel'
headers = {
'Authorization': f'Bearer {claveApi}',
'Content-Type': 'application/json'
}
params = {
}
# Agregue sus datos del cuerpo de la solicitud aquí
request_body = {}
try:
response = requests.post(
url,
headers=headers,
params=params,
json=request_body
)
response.raise_for_status()
data = response.json()
print(data)
return data
except requests.exceptions.RequestException as e:
print(f'Error al llamar a la API: {e}')
raise
llamarApi()
Parámetros
Nombre
Ubicación
Tipo
Requerido
Descripción
id
path
string
Sí
Identificador único
Cuerpo de la solicitud
Requerido
Campos de la solicitud
Nombre
Tipo
Requerido
Descripción
notifyPatient
boolean
No
Envía al paciente un mensaje de cancelación según la configuración de cancelaciones de su clínica. Por defecto es false.
Ejemplo de solicitud
{
"notifyPatient": true
}
Respuestas
Estado
Descripción
200
Respuesta exitosa
400
Datos de entrada no válidos
401
Autorización no proporcionada
403
Acceso insuficiente
500
Error interno del servidor
200 — Respuesta exitosa
Campos de la respuesta
Nombre
Tipo
Requerido
Descripción
id
string
Sí
—
status
string
Sí
—
type
string
Sí
—
title
stringnull
Sí
—
description
stringnull
Sí
—
start_time
string
Sí
—
end_time
string
Sí
—
telemedicine
boolean
Sí
—
video_call_type
string
Sí
Plataforma de video de una cita en línea: LUNAHEALTH, ZOOM o GOOGLE_MEET. NONE en citas presenciales y en las citas en línea donde la clínica envía su propia liga
