Cadastros CRM · criar e atualizar

Esta página concentra as operações privadas de escrita para cadastros auxiliares do CRM.

Escopo atual:

• POST /simplificav2/categoria
• PUT /simplificav2/categoria/{id}
• POST /simplificav2/segmento
• PUT /simplificav2/segmento/{id}
• POST /simplificav2/pessoa_motivo_inativacao
• PUT /simplificav2/pessoa_motivo_inativacao/{id}
• POST /simplificav2/pessoa_origem
• PUT /simplificav2/pessoa_origem/{id}
• POST /simplificav2/tag
• PUT /simplificav2/tag/{id}
• POST /simplificav2/pessoa
• PUT /simplificav2/pessoa/{id}

Autenticação

1
Authorization: Bearer {{bearer_token}}
2
Content-Type: application/json

Regras gerais

• todas as chamadas usam JSON;
• cada chamada opera em um único registro;
• os cadastros criados por POST nascem ativos;
• não existe rota de exclusão por API para esses cadastros auxiliares;
• use PUT com ativo = "N" para inativar;
• use PUT com ativo = "S" para reativar.
• nos PUT, a API atualiza somente os atributos enviados;
• campos omitidos continuam com o valor atual e não são apagados.

Categorias CRM

Rotas

• GET /simplificav2/categoria
• POST /simplificav2/categoria
• PUT /simplificav2/categoria/{id}

Use esse cadastro para manter as categorias do CRM usadas na classificação de pessoas.

Segmentos

Rotas

• GET /simplificav2/segmento
• POST /simplificav2/segmento
• PUT /simplificav2/segmento/{id}

Use esse cadastro para manter os segmentos usados no CRM.

Motivos de inativação

Rotas

• GET /simplificav2/pessoa_motivo_inativacao
• POST /simplificav2/pessoa_motivo_inativacao
• PUT /simplificav2/pessoa_motivo_inativacao/{id}

Observações:

• lead_invalido aceita apenas S ou N;
• quando omitido no POST, o padrão é N.

Origens de pessoa

Rotas

• GET /simplificav2/pessoa_origem
• POST /simplificav2/pessoa_origem
• PUT /simplificav2/pessoa_origem/{id}

Observação:

• a rota cria a origem já pronta para uso no CRM.

Tags

Rotas

• GET /simplificav2/tag
• POST /simplificav2/tag
• PUT /simplificav2/tag/{id}

Observações:

• se a tag já existir, o POST devolve o identificador atual;
• quando o nome muda, a API propaga a alteração para o campo textual de tags das pessoas da empresa.

Pessoas

Rotas

• GET /simplificav2/pessoa
• POST /simplificav2/pessoa
• PUT /simplificav2/pessoa/{id}

Observações:

• o POST cria a pessoa já ativa;
• o POST exige nome_completo, tipo_pessoa_cliente e pelo menos um contato válido entre e-mail e telefone;
• a criação rejeita e-mail ou telefone já cadastrados para outra pessoa da mesma empresa;
• o PUT atualiza somente os campos enviados no JSON;
• campos omitidos continuam com o valor atual e não são apagados;
• e-mail e telefones continuam sendo validados e não podem colidir com outra pessoa da empresa;
• esta rota não altera tipo do cadastro, tipo lead/cliente, status, motivo de inativação, consultor ou foto;
• exclusão e mudanças de status continuam fora da API.

Resposta de sucesso

Todas as operações usam o mesmo retorno mínimo:

1
{
2
  "status": "sucesso",
3
  "mensagem": "Solicitação executada com sucesso.",
4
  "data": {
5
    "id": 123
6
  }
7
}