Actualizar cita

PATCHhttps://api.bydomu.com/v1/appointments/{id}

This reference is generated from the API’s code, so descriptions are in Spanish. Names, parameters and examples are the same in every language.

Actualiza solo los campos enviados. Para cancelar usa POST /appointments/{id}/cancel.

Permission

appointments:write

Keys

Secret only (server-side)

Headers

X-API-Keystringrequired

Your secret key.

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

Path parameters

idstringrequired

ID de la cita

Body (JSON)

titlestring

2–200 chars

descriptionstring

≤ 2000 chars

typestring

SHOWINGMEETINGCALLFOLLOW_UPSIGNINGOTHER

colorstring

startTimestring

nullable

endTimestring

nullable

locationstring

≤ 500 chars

contactIdstring

dealIdstring

nullable

assigneeIdstring

statusstring

SCHEDULEDCONFIRMEDCOMPLETEDCANCELLEDNO_SHOW

remindersobject[]

Responses

200Cita actualizada

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 PATCH "https://api.bydomu.com/v1/appointments/clx1apt001" \ -H "X-API-Key: $BYDOMU_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "startTime": "2026-10-02T16:00:00.000Z", "endTime": "2026-10-02T17:00:00.000Z", "status": "CONFIRMED" }'

const res = await fetch("https://api.bydomu.com/v1/appointments/clx1apt001", { method: "PATCH", headers: { "X-API-Key": process.env.BYDOMU_API_KEY, "Content-Type": "application/json", }, body: JSON.stringify({ "startTime": "2026-10-02T16:00:00.000Z", "endTime": "2026-10-02T17:00:00.000Z", "status": "CONFIRMED" }), }); const data = await res.json();

import os, requests r = requests.patch( "https://api.bydomu.com/v1/appointments/clx1apt001", headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}, json={ "startTime": "2026-10-02T16:00:00.000Z", "endTime": "2026-10-02T17:00:00.000Z", "status": "CONFIRMED" } ) 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" } ] …