Pular para o conteúdo principal
O endpoint Criar Cliente permite que você adicione clientes diretamente ao seu workspace do AgencyHandy a partir de um sistema externo. Ao contrário dos leads, os clientes são contatos totalmente integrados que podem ser atribuídos a pedidos, faturas e projetos. Use este endpoint para sincronizar novos clientes de um CRM, formulário de integração ou qualquer outra fonte de dados.
Antes de usar este endpoint, conclua o guia de Primeiros Passos para obter sua chave de API e ID de Empresa. Ao contrário do endpoint Criar Lead, criar um cliente não requer uma etapa separada de busca de ID de Perfil.

​
Pré-requisitos

  • ✅ Chave de API gerada em Configuração do Workspace → Chave de API
  • ✅ ID de Empresa recuperado de GET {{URL}}/accounts/companies

​
Endpoint

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

​
Headers

HeaderValor
x-api-keySua chave de API
companyIdSeu ID de Empresa
Content-Typeapplication/json

​
Corpo da requisição

O corpo da requisição é um array JSON. Você pode criar um ou mais clientes em uma única requisição.
​
firstName
string
obrigatório
O primeiro nome do cliente.
​
lastName
string
obrigatório
O sobrenome do cliente.
​
email
string
obrigatório
O endereço de e-mail do cliente. Deve ser único dentro do seu workspace.
​
isConvertedClient
boolean
obrigatório
Defina como false para um cliente completamente novo. Defina como true ao converter um lead existente em cliente.
​
status
string
O status do cliente. Valores comuns: New, Active. Padrão: New se omitido.
​
contactNo
string
O número de telefone do cliente.
​
source
string
Como você adquiriu este cliente. Exemplos de valores: website, referral, social.
​
positionInBoard
number
A posição do cliente dentro da coluna do quadro. Padrão: 1.

​
Exemplo de requisição

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
    }
  ]'

​
Resposta de sucesso

{
  "message": "Client created successfully",
  "createdMembers": [
    {
      "_id": "NEW_MEMBER_ID",
      "name": "John Doe",
      "status": "New",
      "role": "client"
    }
  ]
}
​
message
string
String de confirmação em caso de sucesso.
​
createdMembers
array
Array de objetos de cliente criados.
​
createdMembers[].\_id
string
ID único do cliente recém-criado. Use este ID ao atribuir o cliente a pedidos ou faturas via API.
​
createdMembers[].name
string
O nome completo do cliente (firstName + lastName).
​
createdMembers[].status
string
O status do cliente conforme armazenado.
​
createdMembers[].role
string
O perfil atribuído ao membro — será "client".
O header companyId para este endpoint usa letra maiúscula I em Id — companyId — ao contrário de alguns outros endpoints que usam companyid (tudo em minúsculas). Use a capitalização exata mostrada acima para evitar erros de autenticação.
Passe múltiplos objetos de cliente no array para criar clientes em massa em uma única chamada de API. Cada objeto deve ter um endereço de email único. E-mails duplicados causarão um erro de validação para aquela entrada.