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
Fluxo típico
- Procure o cliente em
GET /clients; se não existir, crie comPOST /clients. - Use o
idretornado no campoclientao criar a oportunidade. - Para mais pessoas de contato, use
POST /clients/{id}/contacts. O ID do contato criado aparece na listacontactsda resposta.
Cuidados
PATCHdo cliente preserva o que não vier. Campos omitidos, nulos ou vazios mantêm o valor atual.PUTdo contato substitui o contato. Envie todos os dados que quer manter; campos omitidos podem virar vazio ou padrão.- Contato principal.
main=1torna o contato principal;main=0retira a indicação.maineactivesão numéricos (0ou1). - Documento como texto. Envie
national_idcomo 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.
metadatasegue as definições da conta; consulte Campos customizados.
