Agendar cita

POSThttps://api.bydomu.com/v1/booking/{slug}

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.

Agenda una cita con el agente en un espacio libre (date + startTime en la zona horaria de la página). Queda CONFIRMED si la página confirma sola, si no SCHEDULED. Dispara el webhook BOOKING_CREATED. OJO: la respuesta viene doblemente envuelta, { data: { data: ... } }.

Permissão

booking:write

Chaves

Publicável ou secreta

Cabeçalhos

X-API-Keystringobrigatório

Sua chave publicável ou 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

slugstringobrigatório

Slug de la página de agendamiento del agente

Corpo (JSON)

firstNamestringobrigatório

2–100 chars

lastNamestring

≤ 100 chars

phonestringobrigatório

7–20 chars

emailstring

propertyIdstring

datestringobrigatório

startTimestringobrigatório

messagestring

≤ 500 chars

typestring

SHOWINGMEETINGCALLFOLLOW_UPSIGNINGOTHER · default="SHOWING"

Respostas

201Cita agendada

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/booking/carlos-rodriguez" \ -H "X-API-Key: $BYDOMU_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "firstName": "María", "lastName": "González", "phone": "+573001234567", "email": "[email protected]", "date": "2026-10-05", "startTime": "09:00", "type": "SHOWING", "propertyId": "clx1prop001" }'

const res = await fetch("https://api.bydomu.com/v1/booking/carlos-rodriguez", { method: "POST", headers: { "X-API-Key": process.env.BYDOMU_API_KEY, "Content-Type": "application/json", }, body: JSON.stringify({ "firstName": "María", "lastName": "González", "phone": "+573001234567", "email": "[email protected]", "date": "2026-10-05", "startTime": "09:00", "type": "SHOWING", "propertyId": "clx1prop001" }), }); const data = await res.json();

import os, requests r = requests.post( "https://api.bydomu.com/v1/booking/carlos-rodriguez", headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]}, json={ "firstName": "María", "lastName": "González", "phone": "+573001234567", "email": "[email protected]", "date": "2026-10-05", "startTime": "09:00", "type": "SHOWING", "propertyId": "clx1prop001" } ) data = r.json()

{ "data": { "data": { "appointmentId": "clx1apt009", "status": "CONFIRMED", "ownerNotified": { "firstName": "Carlos", "lastName": "Rodríguez" } } } }