Ir al contenido
Koibox Documentación para desarrolladores de Koibox

Crear una cita

POST
/api/agenda/

Authorizations

Sección titulada «Authorizations »

Request Body

Sección titulada «Request Body »
object
id

Solo lectura

integer
notas
string
duracion
string format: time
created

Solo lectura

string format: date-time
updated

Solo lectura

string format: date-time
titulo
required
string
observaciones
string
historico

Solo lectura

string format: html
is_empleado_aleatorio
boolean
fecha
required

Fecha de la cita, se espera en zona horaria del centro

string format: date
hora_inicio
required
string format: time
hora_fin

Obligatorio en citas con servicios normales y sin servicios combinados. No incluir en citas con servicios combinados.

string format: time
is_notificada_por_sms

Solo lectura

boolean
is_notificada_por_email

Solo lectura

boolean
is_notificada_por_push

Solo lectura

boolean
origen

Solo lectura

string
Allowed values: c p w f i a t in pa pc g s api ig
precio

Solo lectura

number
precio_sin_descuento

Solo lectura

number
descuento

Solo lectura

number
is_cliente_en_centro
boolean
is_notificada_por_whatsapp

Solo lectura

boolean
user
required
One of:

Solo lectura

object
value

Identificador del usuario

integer
text

Nombre del usuario

string
color
string format: hex
username
string format: email
foto_url_absolute_path
string format: uri
created_by

Solo lectura

object
value

Identificador del usuario

integer
text

Nombre del usuario

string
color
string format: hex
username
string format: email
foto_url_absolute_path
string format: uri
cliente
One of:

Solo lectura

object
text

Nombre del cliente

string
value

Identificador del cliente

integer
email
string format: email
movil

Número de móvil del cliente

string format: tel
notas
string
is_anonymous
boolean
foto_url_absolute_path
string format: uri
localidad
string
importe_ventas
number
importe_deudas
number
code
integer
manual_code
string
fijo
string
dni
string
prefijo_tel
integer
estado
One of:

Solo lectura

object
id

Identificador del estado

integer
value
integer
nombre
string
text
string
parent

Cita padre a la actual, solo lectura

integer
servicios
One of:

Solo escritura

integer
servicios_combinados

Ids de los servicios combinados de la cita, solo escritura. Incluir servicios combinados en la cita la dividirá por servicios automáticamente.

Array<integer>
created_timezone

Tiempo ajustado a la zona horaria del centro, solo lectura

string format: date-time
venta

Venta creada desde la cita, solo lectura

integer

Responses

Sección titulada « Responses »

201

Sección titulada «201 »

La cita creada. Si se incluyen servicios combinados se divide por servicios automáticamente por lo que se devuelve un array con cada cita creada.

One of:
object
id

Solo lectura

integer
notas
string
duracion
string format: time
created

Solo lectura

string format: date-time
updated

Solo lectura

string format: date-time
titulo
required
string
observaciones
string
historico

Solo lectura

string format: html
is_empleado_aleatorio
boolean
fecha
required

Fecha de la cita, se espera en zona horaria del centro

string format: date
hora_inicio
required
string format: time
hora_fin

Obligatorio en citas con servicios normales y sin servicios combinados. No incluir en citas con servicios combinados.

string format: time
is_notificada_por_sms

Solo lectura

boolean
is_notificada_por_email

Solo lectura

boolean
is_notificada_por_push

Solo lectura

boolean
origen

Solo lectura

string
Allowed values: c p w f i a t in pa pc g s api ig
precio

Solo lectura

number
precio_sin_descuento

Solo lectura

number
descuento

Solo lectura

number
is_cliente_en_centro
boolean
is_notificada_por_whatsapp

Solo lectura

boolean
user
required
One of:

Solo lectura

object
value

Identificador del usuario

integer
text

Nombre del usuario

string
color
string format: hex
username
string format: email
foto_url_absolute_path
string format: uri
created_by

Solo lectura

object
value

Identificador del usuario

integer
text

Nombre del usuario

string
color
string format: hex
username
string format: email
foto_url_absolute_path
string format: uri
cliente
One of:

Solo lectura

object
text

Nombre del cliente

string
value

Identificador del cliente

integer
email
string format: email
movil

Número de móvil del cliente

string format: tel
notas
string
is_anonymous
boolean
foto_url_absolute_path
string format: uri
localidad
string
importe_ventas
number
importe_deudas
number
code
integer
manual_code
string
fijo
string
dni
string
prefijo_tel
integer
estado
One of:

Solo lectura

object
id

Identificador del estado

integer
value
integer
nombre
string
text
string
parent

Cita padre a la actual, solo lectura

integer
servicios
One of:

Solo escritura

integer
servicios_combinados

Ids de los servicios combinados de la cita, solo escritura. Incluir servicios combinados en la cita la dividirá por servicios automáticamente.

Array<integer>
created_timezone

Tiempo ajustado a la zona horaria del centro, solo lectura

string format: date-time
venta

Venta creada desde la cita, solo lectura

integer

400

Sección titulada «400 »

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

401

Sección titulada «401 »

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

Headers

Sección titulada «Headers »
WWW-Authenticate
string
default: X-Koibox-Key

Indica la cabecera requerida para la autenticación

403

Sección titulada «403 »

No se ha proporcionado una clave de acceso válida