For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentaçãoReferência da API
DocumentaçãoReferência da API
  • Integrações privadas
        • GETListar Leads via Integração
        • GETListar consultores
        • GETListar pessoas
        • POSTCriar pessoa
        • PUTAtualizar pessoa
        • GETListar endereços
  • Entrada pública de leads
LogoLogo
Integrações privadasCRMCadastros

Criar pessoa

||View as Markdown|
POST
/simplificav2/pessoa
POST
/ords/gestao/simplificav2/pessoa
$curl -X POST https://gestao.simplificagestao.com.br/ords/gestao/simplificav2/pessoa \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "nome_completo": "string",
> "tipo_pessoa_cliente": "string"
>}'
1{
2 "status": "sucesso",
3 "mensagem": "Solicitação executada com sucesso.",
4 "data": {
5 "id": 1
6 }
7}
Cria uma nova pessoa no CRM. Regras: - o cadastro nasce ativo; - a rota exige `nome_completo` e `tipo_pessoa_cliente`; - o estado final precisa manter ao menos uma forma de contato válida entre e-mail, celular ou telefone; - a criação rejeita e-mail ou telefone já cadastrados para outra pessoa; - `tipo_registro` segue o comportamento padrão do CRM quando não for enviado; - esta rota não aceita campos de status, motivo de inativação, consultor nem foto; - exclusão e ações de status continuam fora deste endpoint. Exemplo de uso: ```http POST {{base_url}}/simplificav2/pessoa Authorization: Bearer {{bearer_token}} Content-Type: application/json { "nome_completo": "André Souza", "email": "andre@empresa.com.br", "celular_1": "85999998888", "origem_id": 23, "categoria_id": 4, "segmento_id": 9, "obs": "Cadastro criado pela integração" } ```
Was this page helpful?
Previous

Listar pessoas

Next

Atualizar pessoa

Built with

Cria uma nova pessoa no CRM.

Regras:

  • o cadastro nasce ativo;
  • a rota exige nome_completo e tipo_pessoa_cliente;
  • o estado final precisa manter ao menos uma forma de contato válida entre e-mail, celular ou telefone;
  • a criação rejeita e-mail ou telefone já cadastrados para outra pessoa;
  • tipo_registro segue o comportamento padrão do CRM quando não for enviado;
  • esta rota não aceita campos de status, motivo de inativação, consultor nem foto;
  • exclusão e ações de status continuam fora deste endpoint.

Exemplo de uso:

1POST {{base_url}}/simplificav2/pessoa
2Authorization: Bearer {{bearer_token}}
3Content-Type: application/json
4
5{
6 "nome_completo": "André Souza",
7 "email": "andre@empresa.com.br",
8 "celular_1": "85999998888",
9 "origem_id": 23,
10 "categoria_id": 4,
11 "segmento_id": 9,
12 "obs": "Cadastro criado pela integração"
13}

Authentication

AuthorizationBearer
Token privado usado para consultar dados da plataforma. Como usar: - obtenha o token privado da sua empresa; - envie `Authorization: Bearer SEU_TOKEN_PRIVADO`; - não use `x-api-key` neste módulo.

Request

This endpoint expects an object.
nome_completostringRequired
Nome principal da pessoa.
tipo_pessoa_clientestringRequired

Classificação principal do cadastro. Use L para lead ou C para cliente.

cpfstring or nullOptional

CPF da pessoa física.

cnpjstring or nullOptional

CNPJ da pessoa jurídica.

nascimentostring or nullOptional

Data de nascimento no formato YYYY-MM-DD.

emailstring or nullOptional
celular_1string or nullOptional
celular_2string or nullOptional
telefone_fixostring or nullOptional
origem_idinteger or nullOptional
tipo_registrostring or nullOptional

Tipo do cadastro. Use PF para pessoa física ou PJ para pessoa jurídica.

fornecedorstring or nullOptional

Informe S para marcar como fornecedor ou N para manter como não fornecedor.

sexostring or nullOptional

Use M ou F quando aplicável.

pessoa_indicacao_idinteger or nullOptional
nome_fantasiastring or nullOptional
contatostring or nullOptional
insc_estadualstring or nullOptional
insc_municipalstring or nullOptional
site_urlstring or nullOptional
obsstring or nullOptional
categoria_idinteger or nullOptional
segmento_idinteger or nullOptional
interessesstring or nullOptional

Lista de identificadores separada por ; ou :.

tagstring or nullOptional

Lista textual de tags separada por ; ou :.

Response

Pessoa criada com sucesso.
statusstring
mensagemstring
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error

Token privado usado para consultar dados da plataforma.

Como usar:

  • obtenha o token privado da sua empresa;
  • envie Authorization: Bearer SEU_TOKEN_PRIVADO;
  • não use x-api-key neste módulo.