Lead

Lista Leads

get

Retorna a lista de leads ativos.

Autorizações

bearer

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de consulta

filtrostringOpcional

Aceita informar nome, CPF, CNPJ, telefone ou email.

Respostas

200

Lista de leads

application/json

401

Não autorizado

text/plain

get

/ext/crm/lead

HTTPcURLJavaScriptPython

GET /siprov-api/ext/crm/lead HTTP/1.1
Host: acesso.siprov.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "cpfCnpj": "text",
  "id": 1,
  "nome": "text"
}

Gravar Lead

post

Grava um lead com dados básicos do contato.

Autorizações

bearer

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

application/json

codLojainteger · int32Opcional

codPessoainteger · int32Opcional

codUsuarioResponsavelinteger · int32Opcional

cpfCnpjstringOpcional

dataNascimentostringOpcionalExample: yyyy-MM-ddPattern: ^(\d{4}\-\d{2}\-\d{2})?$

emailstringOpcional

naturezastring · enumOpcionalValores possíveis:

nomePessoastringOpcional

observacaostringOpcional

sexostring · enumOpcionalValores possíveis:

Respostas

200

Cadastro gravado com sucesso

application/json

401

Não autorizado

text/plain

post

/ext/crm/lead

HTTPcURLJavaScriptPython

POST /siprov-api/ext/crm/lead HTTP/1.1
Host: acesso.siprov.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 431

{
  "codLoja": 1,
  "codPessoa": 1,
  "codUsuarioResponsavel": 1,
  "cpfCnpj": "text",
  "dataNascimento": "yyyy-MM-dd",
  "email": "text",
  "endereco": {
    "bairro": "text",
    "cep": "text",
    "cidade": "text",
    "codEndereco": 1,
    "complemento": "text",
    "logradouro": "text",
    "numero": "text",
    "tipoEndereco": "text",
    "tipoLogradouro": "text",
    "uf": "text"
  },
  "natureza": "F",
  "nomePessoa": "text",
  "observacao": "text",
  "sexo": "Feminino",
  "telefones": [
    {
      "ddi": 1,
      "numero": "text",
      "tipo": "Fixo"
    }
  ]
}

{
  "codPessoa": 1
}