Saltar al contenido principal
El endpoint Create Client le permite añadir clientes directamente a su espacio de trabajo de AgencyHandy desde un sistema externo. A diferencia de los leads, los clientes son contactos completamente incorporados que pueden asignarse a pedidos, facturas y proyectos. Use este endpoint para sincronizar nuevos clientes desde un CRM, un formulario de incorporación o cualquier otra fuente de datos.
Antes de usar este endpoint, complete la guía Getting Started para obtener su clave de API y su Company ID. A diferencia del endpoint Create Lead, la creación de un cliente no requiere un paso separado para obtener el Role ID.

​
Requisitos previos

  • ✅ Clave de API generada desde Workspace Config → API Key
  • ✅ Company ID obtenido de GET {{URL}}/accounts/companies

​
Endpoint

POST {{URL}}/members/bulk-client

​
Encabezados

EncabezadoValor
x-api-keySu clave de API
companyIdSu Company ID
Content-Typeapplication/json

​
Cuerpo de la solicitud

El cuerpo de la solicitud es un array JSON. Puede crear uno o más clientes en una sola solicitud.
​
firstName
string
requerido
El nombre del cliente.
​
lastName
string
requerido
El apellido del cliente.
​
email
string
requerido
La dirección de correo electrónico del cliente. Debe ser única dentro de su espacio de trabajo.
​
isConvertedClient
boolean
requerido
Establézcalo en false para un cliente completamente nuevo. Establézcalo en true al convertir un lead existente en un cliente.
​
status
string
El estado del cliente. Valores comunes: New, Active. Por defecto es New si se omite.
​
contactNo
string
El número de teléfono del cliente.
​
source
string
Cómo adquirió este cliente. Valores de ejemplo: website, referral, social.
​
positionInBoard
number
La posición del cliente dentro de la columna del tablero. Por defecto es 1.

​
Solicitud de ejemplo

cURL
curl --request POST "https://api.agencyhandy.com/members/bulk-client" \
  --header "x-api-key: <YOUR_API_KEY>" \
  --header "companyId: <YOUR_COMPANY_ID>" \
  --header "Content-Type: application/json" \
  --data '[
    {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "isConvertedClient": false,
      "status": "New",
      "contactNo": "1234567890",
      "source": "website",
      "positionInBoard": 1
    }
  ]'

​
Respuesta de éxito

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
Cadena de confirmación en caso de éxito.
​
createdMembers
array
Array de objetos de cliente creados.
​
createdMembers[].\_id
string
ID único del cliente recién creado. Use este ID al asignar el cliente a pedidos o facturas a través de la API.
​
createdMembers[].name
string
El nombre completo del cliente (firstName + lastName).
​
createdMembers[].status
string
El estado del cliente tal como se almacenó.
​
createdMembers[].role
string
El rol asignado al miembro — será "client".
El encabezado companyId para este endpoint usa una I mayúscula en Id — companyId — a diferencia de algunos otros endpoints que usan companyid (todo en minúsculas). Use exactamente la grafía mostrada arriba para evitar errores de autenticación.
Pase varios objetos de cliente en el array para crear clientes de forma masiva en una sola llamada a la API. Cada objeto debe tener una dirección email única. Los correos electrónicos duplicados provocarán un error de validación para esa entrada.