Crear cliente en Acuity Scheduling, con una API
Agrega un cliente a la lista de clientes y lo devuelve. Un cliente que ya existe recibe 400 con el mensaje That client already exists.
- Identificador
- acuity_create_client
La llamada
POST https://connect.reportei.com/api/tools/acuity_create_client/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"firstName": "<firstName>",
"lastName": "<lastName>"
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| firstName | string | Sí | First name of the client. |
| lastName | string | Sí | Last name of the client. |
| string | No | Email address of the client. | |
| phone | string | No | Phone number of the client. |
| notes | string | No | Notes about the client. |
Conexiones posibles
Tu cliente conecta su cuenta de Acuity Scheduling una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Usuario y contraseña
Tu cliente ingresa las credenciales de la app en una pantalla de Connect, o tu sistema las envía con POST /api/customer-toolkits, sin pantalla.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/acuity_create_client. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Acuity Scheduling
- Listar citasGETLista las citas de la cuenta, de la más reciente a la más antigua por defecto, hasta max por llamada. No hay token de página: cuando una llamada devuelve max citas, acota minDate y maxDate. Las citas canceladas solo vienen con canceled o showall.
- Obtener citaGETDevuelve una cita, con nombre, correo y teléfono del cliente, datetime, endTime, type, calendar, price, paid, notes, las respuestas del formulario de ingreso en forms, labels y confirmationPage. Una cita cancelada también tiene noShow.
- Crear citaPOSTReserva una cita y la devuelve. Por defecto se reserva como lo haría un cliente: la hora debe estar libre y los campos obligatorios del formulario respondidos. Con admin true se omiten esas comprobaciones y calendarID es obligatorio. El cliente recibe el correo y el SMS de confirmación, salvo que noEmail sea true.
- Actualizar citaPUTActualiza los datos del cliente, las respuestas del formulario o las notas de una cita y la devuelve. Solo cambian los campos enviados, y firstName y lastName no se pueden borrar. La fecha, la hora y el calendario cambian con Reschedule appointment.
- Cancelar citaPUTCancela una cita y la devuelve. Una cita cancelada no se puede restaurar. Por defecto rigen las reglas de cancelación de los clientes; con admin true se omiten y se puede definir noShow. El cliente recibe el correo y el SMS de cancelación, salvo que noEmail sea true.
- Reprogramar citaPUTMueve una cita a otra fecha y hora, a otro calendario o a ambos, y la devuelve. La nueva hora debe estar libre, salvo que admin sea true. Las citas canceladas y las series de clases no se pueden reprogramar. El cliente recibe el correo y el SMS de reprogramación, salvo que noEmail sea true.
- Listar tipos de citaGETLista los tipos de cita, los servicios y las clases que reservan los clientes, con id, name, duración en minutos, price, type (service, class o series), private y calendarIDs, los calendarios que ofrecen cada uno.
- Listar calendariosGETLista los calendarios a los que la cuenta puede acceder, normalmente uno por miembro del equipo, con id, name, email, location y timezone.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
