Skip to navigation

Overview

O cliente é quem recebe a proposta. Cada cliente tem um cadastro (nome, documento, contato, endereço, campos personalizados) e uma lista de contatos, dos quais um pode ser o principal. Toda oportunidade aponta para um cliente pelo campo client.

Rotas

MétodoRotaPara quê
GET/clientsListar clientes acessíveis ao usuário.
POST/clientsCriar cliente; só name é obrigatório.
GET/clients/{id}Detalhar cliente: cadastro, contatos e resumo comercial.
PATCH/clients/{id}Atualizar cliente, inclusive o contato principal via main_contact.
DELETE/clients/{id}Remover cliente sem histórico vinculado.
POST/clients/{id}/contactsAdicionar contato ao cliente.
PUT/clients/{id}/contacts/{contactId}Atualizar contato do cliente.
DELETE/clients/{id}/contacts/{contactId}Remover contato do cliente.

Fluxo típico

  1. Procure o cliente em GET /clients; se não existir, crie com POST /clients.
  2. Use o id retornado no campo client ao criar a oportunidade.
  3. Para mais pessoas de contato, use POST /clients/{id}/contacts. O ID do contato criado aparece na lista contacts da resposta.

Cuidados

  • PATCH do cliente preserva o que não vier. Campos omitidos, nulos ou vazios mantêm o valor atual.
  • PUT do contato substitui o contato. Envie todos os dados que quer manter; campos omitidos podem virar vazio ou padrão.
  • Contato principal. main=1 torna o contato principal; main=0 retira a indicação. main e active são numéricos (0 ou 1).
  • Documento como texto. Envie national_id como string, para não perder zeros à esquerda.
  • Exclusão só sem histórico. Cliente com propostas ou atividades vinculadas não pode ser excluído (HTTP 409).
  • Campos personalizados. metadata segue as definições da conta; consulte Campos customizados.