Saltearse al contenido
Koibox Documentación para desarrolladores de Koibox

Crear un bloqueo en la agenda

POST
/api/bloqueos/

Authorizations

Request Body

object
id

Solo lectura

integer
created

Solo lectura

string format: date-time
updated

Solo lectura

string format: date-time
created_by

Id del usuario creador, solo lectura

integer
user
required

Id del usuario al que afecta el bloqueo

integer
centro
required
integer
fecha
required

Fecha del bloqueo, se espera en zona horaria del centro

string format: date
hora_inicio
required
string format: time
hora_fin
required
string format: time
titulo
required
string
recurrencia
required

Cada cuanto se repite el bloqueo, day_1___ == cada día

string
Allowed values: none day_1___ week_1___ week_2___ month_1___
is_online

Determina si el bloqueo afecta a las reservas online. Obligatorio si cita no es nulo

boolean
cita

Cita online que ha creado el bloqueo. Obligatorio si is_online es true

integer
employee_name

Nombre completo del empleado, solo lectura

string
recurrence_description

Solo lectura

string

Responses

201

El bloqueo creado

object
id

Solo lectura

integer
created

Solo lectura

string format: date-time
updated

Solo lectura

string format: date-time
created_by

Id del usuario creador, solo lectura

integer
user
required

Id del usuario al que afecta el bloqueo

integer
centro
required
integer
fecha
required

Fecha del bloqueo, se espera en zona horaria del centro

string format: date
hora_inicio
required
string format: time
hora_fin
required
string format: time
titulo
required
string
recurrencia
required

Cada cuanto se repite el bloqueo, day_1___ == cada día

string
Allowed values: none day_1___ week_1___ week_2___ month_1___
is_online

Determina si el bloqueo afecta a las reservas online. Obligatorio si cita no es nulo

boolean
cita

Cita online que ha creado el bloqueo. Obligatorio si is_online es true

integer
employee_name

Nombre completo del empleado, solo lectura

string
recurrence_description

Solo lectura

string

400

La petición está mal formada, faltan campos requeridos.

401

No se ha proporcionado la clave de acceso en la header X-Koibox-Key

Headers

WWW-Authenticate
string
default: X-Koibox-Key

Indica la cabecera requerida para la autenticación

403

No se ha proporcionado una clave de acceso válida