Skip to navigation

Ver las políticas de Citas

Las políticas con que la cuenta toma citas (Configuración → Citas → Políticas), con los valores por defecto ya resueltos: anticipación, ventana para reservar, intervalo entre horarios, límite diario, si el negocio acepta cada cita a mano, la protección por defecto, el cargo por inasistencia, la ventana de cancelación y dónde llega el cliente.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Response

Las políticas

currencystringOptionalRead-only
La moneda de la cuenta, en que se cobra el cargo por inasistencia.
min_lead_minutesintegerOptional

Anticipación mínima para reservar, en minutos (0 a 40,320).

max_advance_daysintegerOptional

Hasta cuántos días adelante se puede reservar (1 a 365).

slot_intervalenumOptional

Cada cuánto empiezan los horarios; service los separa por la duración de la cita.

Allowed values:
daily_limit_kindenumOptional
Allowed values:
daily_limitinteger or nullOptional

Máximo de citas por día (por profesional o por cuenta); null sin límite.

cancellation_window_hoursintegerOptional

Hasta cuántas horas antes puede cancelar o mover el cliente (0 a 336).

accept_policyenumOptional

requires_acceptance: el negocio acepta cada cita a mano.

Allowed values:
default_payment_policyenumOptional

La protección de los servicios que no eligen la suya.

Allowed values:
no_show_fee_kindenumOptional
Allowed values:
no_show_fee_amount_in_centsinteger or nullOptional
El cargo por inasistencia fijo, en centavos de la moneda de la cuenta.
no_show_fee_percentstring or nullOptional

El cargo como porcentaje del precio (con no_show_fee_kind en percent).

no_show_fee_window_daysintegerOptional

Cuántos días después de la cita se puede cobrar la inasistencia (1 a 60).

policy_textstring or nullOptional

La política que lee el cliente al reservar.

addressstring or nullOptional
instructionsstring or nullOptional
Indicaciones para llegar.
allow_customer_cancelbooleanOptional
Si el cliente puede cancelar o mover su cita desde su link.
deposit_refundablebooleanOptional
Si el anticipo se devuelve cuando el cliente cancela a tiempo.
multiple_servicesbooleanOptional
Si el cliente puede reservar varios servicios en una visita.
multiple_staffbooleanOptional
Si una visita puede repartirse entre varios profesionales.

Errors

403
Forbidden Error