Cancelar cita

POSThttps://api.bydomu.com/v1/appointments/{id}/cancel

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

Marca la cita como cancelada y anula sus recordatorios pendientes.

Permissão

appointments:write

Chaves

Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório

Sua chave secreta.

Idempotency-Keystring

Clave única de la operación (8-128 caracteres de [a-zA-Z0-9._:-]). Un reintento con la misma clave y el mismo cuerpo devuelve la respuesta original sin repetir la operación. Vive 24 horas. · 8–128 chars

Parâmetros de rota

idstringobrigatório

ID de la cita

Corpo (JSON)

reasonstring

≤ 500 chars

Respostas

200Cita cancelada

400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.

401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.

402PAYMENT_REQUIRED · Cuenta en modo solo lectura: se rechaza toda mutación.

403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.

404NOT_FOUND · El recurso no existe en la organización.

409DUPLICATE · Choca con un dato existente o con el estado actual, o la `Idempotency-Key` ya se usó con otro cuerpo o sigue en curso.

429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.

500INTERNAL_ERROR · Error interno del servidor.

curl -X POST "https://api.bydomu.com/v1/appointments/clx1apt001/cancel" \ -H "X-API-Key: $BYDOMU_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "reason": "El cliente reagendará la próxima semana" }'

const res = await fetch("https://api.bydomu.com/v1/appointments/clx1apt001/cancel", { method: "POST", headers: { "X-API-Key": process.env.BYDOMU_API_KEY, "Content-Type": "application/json", }, body: JSON.stringify({ "reason": "El cliente reagendará la próxima semana" }), }); const data = await res.json();

import os, requests r = requests.post( "https://api.bydomu.com/v1/appointments/clx1apt001/cancel", headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}, json={ "reason": "El cliente reagendará la próxima semana" } ) data = r.json()

{ "data": { "id": "clx1apt001", "title": "Visita Apto Chapinero", "description": "Segunda visita; llevar el certificado de libertad.", "type": "SHOWING", "status": "SCHEDULED", "startTime": "2026-10-02T15:00:00.000Z", "endTime": "2026-10-02T16:00:00.000Z", "color": "#6366F1", "location": "Cra 7 #45-12, Bogotá", "createdAt": "2026-09-25T09:00:00.000Z", "cancelReason": "El cliente reagendará", "source": "MANUAL", "contactId": "clx1con001", "dealId": "clx1deal001", "propertyId": "clx1prop001", "assigneeId": "clx1usr001", "createdById": "clx1usr002", "updatedAt": "2026-09-25T09:00:00.000Z", "contact": { "id": "clx1con001", "firstName": "María", "lastName": "González", "phone": "+573001234567" }, "deal": { "id": "clx1deal001", "title": "Venta Apto Chapinero" }, "assignee": { "id": "clx1usr001", "firstName": "Carlos", "lastName": "Rodríguez" }, "reminders": [ { "id": "clx1rem001", "channel": "WHATSAPP", "minutesBefore": 60, "scheduledFor": "2026-10-02T14:00:00.000Z", "status": "PENDING" } ] …