Saltar para o conteúdo principal
O endpoint Criar Cliente permite-lhe adicionar clientes diretamente ao seu workspace AgencyHandy a partir de um sistema externo. Ao contrário dos leads, os clientes são contactos totalmente integrados que podem ser atribuídos a encomendas, faturas e projetos. Utilize este endpoint para sincronizar novos clientes a partir de um CRM, formulário de integração ou qualquer outra fonte de dados.
Antes de utilizar este endpoint, complete o guia de Primeiros Passos para obter a 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 consulta de ID de Função.

​
Pré-requisitos

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

​
Endpoint

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

​
Cabeçalhos

CabeçalhoValor
x-api-keyA sua chave de API
companyIdO seu ID de Empresa
Content-Typeapplication/json

​
Corpo do pedido

O corpo do pedido é um array JSON. Pode criar um ou mais clientes num único pedido.
​
firstName
string
obrigatório
O primeiro nome do cliente.
​
lastName
string
obrigatório
O apelido do cliente.
​
email
string
obrigatório
O endereço de e-mail do cliente. Deve ser único no seu workspace.
​
isConvertedClient
boolean
obrigatório
Defina como false para um cliente completamente novo. Defina como true ao converter um lead existente num cliente.
​
status
string
O estado do cliente. Valores comuns: New, Active. Predefinição para New se omitido.
​
contactNo
string
O número de telefone do cliente.
​
source
string
Como adquiriu este cliente. Valores de exemplo: website, referral, social.
​
positionInBoard
number
A posição do cliente na coluna do quadro. Predefinição para 1.

​
Exemplo de pedido

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
Texto 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. Utilize este ID ao atribuir o cliente a encomendas ou faturas através da API.
​
createdMembers[].name
string
O nome completo do cliente (firstName + lastName).
​
createdMembers[].status
string
O estado do cliente tal como armazenado.
​
createdMembers[].role
string
A função atribuída ao membro — será "client".
O cabeçalho companyId para este endpoint utiliza I maiúsculo em Id — companyId — ao contrário de alguns outros endpoints que utilizam companyid (tudo em minúsculas). Utilize a capitalização exata indicada acima para evitar erros de autenticação.
Passe múltiplos objetos de cliente no array para criar clientes em massa numa única chamada à API. Cada objeto deve ter um endereço de email único. E-mails duplicados causarão um erro de validação para essa entrada.