Cria um prospect.
curl --request POST \
--url https://api.example.com/api/services/app/Crm/CriarProspect \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"id": 123,
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"segment": 123,
"observation": "<string>",
"registryCode": "<string>",
"postalCode": "<string>",
"street": "<string>",
"number": "<string>",
"additional": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"contactName": "<string>",
"contactEmail": "<string>",
"contactCellPhone": "<string>",
"contactRegistryCode": "<string>",
"contactBirth": "2023-11-07T05:31:56Z",
"group": "<string>",
"subsidiaries": 123,
"cdcSaude": true,
"cdcCelular": true,
"epCelular": true,
"cartaoLoja": true,
"fgtsBmp": true,
"operacaoCredito": true,
"status": 123
}
'import requests
url = "https://api.example.com/api/services/app/Crm/CriarProspect"
payload = {
"id": 123,
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"segment": 123,
"observation": "<string>",
"registryCode": "<string>",
"postalCode": "<string>",
"street": "<string>",
"number": "<string>",
"additional": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"contactName": "<string>",
"contactEmail": "<string>",
"contactCellPhone": "<string>",
"contactRegistryCode": "<string>",
"contactBirth": "2023-11-07T05:31:56Z",
"group": "<string>",
"subsidiaries": 123,
"cdcSaude": True,
"cdcCelular": True,
"epCelular": True,
"cartaoLoja": True,
"fgtsBmp": True,
"operacaoCredito": True,
"status": 123
}
headers = {"Content-Type": "application/json-patch+json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
id: 123,
name: '<string>',
phone: '<string>',
email: '<string>',
segment: 123,
observation: '<string>',
registryCode: '<string>',
postalCode: '<string>',
street: '<string>',
number: '<string>',
additional: '<string>',
neighborhood: '<string>',
city: '<string>',
state: '<string>',
contactName: '<string>',
contactEmail: '<string>',
contactCellPhone: '<string>',
contactRegistryCode: '<string>',
contactBirth: '2023-11-07T05:31:56Z',
group: '<string>',
subsidiaries: 123,
cdcSaude: true,
cdcCelular: true,
epCelular: true,
cartaoLoja: true,
fgtsBmp: true,
operacaoCredito: true,
status: 123
})
};
fetch('https://api.example.com/api/services/app/Crm/CriarProspect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/services/app/Crm/CriarProspect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => 123,
'name' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'segment' => 123,
'observation' => '<string>',
'registryCode' => '<string>',
'postalCode' => '<string>',
'street' => '<string>',
'number' => '<string>',
'additional' => '<string>',
'neighborhood' => '<string>',
'city' => '<string>',
'state' => '<string>',
'contactName' => '<string>',
'contactEmail' => '<string>',
'contactCellPhone' => '<string>',
'contactRegistryCode' => '<string>',
'contactBirth' => '2023-11-07T05:31:56Z',
'group' => '<string>',
'subsidiaries' => 123,
'cdcSaude' => true,
'cdcCelular' => true,
'epCelular' => true,
'cartaoLoja' => true,
'fgtsBmp' => true,
'operacaoCredito' => true,
'status' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/services/app/Crm/CriarProspect"
payload := strings.NewReader("{\n \"id\": 123,\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"segment\": 123,\n \"observation\": \"<string>\",\n \"registryCode\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"additional\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"contactName\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"contactCellPhone\": \"<string>\",\n \"contactRegistryCode\": \"<string>\",\n \"contactBirth\": \"2023-11-07T05:31:56Z\",\n \"group\": \"<string>\",\n \"subsidiaries\": 123,\n \"cdcSaude\": true,\n \"cdcCelular\": true,\n \"epCelular\": true,\n \"cartaoLoja\": true,\n \"fgtsBmp\": true,\n \"operacaoCredito\": true,\n \"status\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/services/app/Crm/CriarProspect")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"id\": 123,\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"segment\": 123,\n \"observation\": \"<string>\",\n \"registryCode\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"additional\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"contactName\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"contactCellPhone\": \"<string>\",\n \"contactRegistryCode\": \"<string>\",\n \"contactBirth\": \"2023-11-07T05:31:56Z\",\n \"group\": \"<string>\",\n \"subsidiaries\": 123,\n \"cdcSaude\": true,\n \"cdcCelular\": true,\n \"epCelular\": true,\n \"cartaoLoja\": true,\n \"fgtsBmp\": true,\n \"operacaoCredito\": true,\n \"status\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/services/app/Crm/CriarProspect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"id\": 123,\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"segment\": 123,\n \"observation\": \"<string>\",\n \"registryCode\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"additional\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"contactName\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"contactCellPhone\": \"<string>\",\n \"contactRegistryCode\": \"<string>\",\n \"contactBirth\": \"2023-11-07T05:31:56Z\",\n \"group\": \"<string>\",\n \"subsidiaries\": 123,\n \"cdcSaude\": true,\n \"cdcCelular\": true,\n \"epCelular\": true,\n \"cartaoLoja\": true,\n \"fgtsBmp\": true,\n \"operacaoCredito\": true,\n \"status\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"segment": 123,
"observation": "<string>",
"registryCode": "<string>",
"postalCode": "<string>",
"street": "<string>",
"number": "<string>",
"additional": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"contactName": "<string>",
"contactEmail": "<string>",
"contactCellPhone": "<string>",
"contactRegistryCode": "<string>",
"contactBirth": "2023-11-07T05:31:56Z",
"group": "<string>",
"subsidiaries": 123,
"cdcSaude": true,
"cdcCelular": true,
"epCelular": true,
"cartaoLoja": true,
"fgtsBmp": true,
"operacaoCredito": true,
"status": 123
}Prospects
Criar prospect
POST
/
api
/
services
/
app
/
Crm
/
CriarProspect
Cria um prospect.
curl --request POST \
--url https://api.example.com/api/services/app/Crm/CriarProspect \
--header 'Content-Type: application/json-patch+json' \
--data '
{
"id": 123,
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"segment": 123,
"observation": "<string>",
"registryCode": "<string>",
"postalCode": "<string>",
"street": "<string>",
"number": "<string>",
"additional": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"contactName": "<string>",
"contactEmail": "<string>",
"contactCellPhone": "<string>",
"contactRegistryCode": "<string>",
"contactBirth": "2023-11-07T05:31:56Z",
"group": "<string>",
"subsidiaries": 123,
"cdcSaude": true,
"cdcCelular": true,
"epCelular": true,
"cartaoLoja": true,
"fgtsBmp": true,
"operacaoCredito": true,
"status": 123
}
'import requests
url = "https://api.example.com/api/services/app/Crm/CriarProspect"
payload = {
"id": 123,
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"segment": 123,
"observation": "<string>",
"registryCode": "<string>",
"postalCode": "<string>",
"street": "<string>",
"number": "<string>",
"additional": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"contactName": "<string>",
"contactEmail": "<string>",
"contactCellPhone": "<string>",
"contactRegistryCode": "<string>",
"contactBirth": "2023-11-07T05:31:56Z",
"group": "<string>",
"subsidiaries": 123,
"cdcSaude": True,
"cdcCelular": True,
"epCelular": True,
"cartaoLoja": True,
"fgtsBmp": True,
"operacaoCredito": True,
"status": 123
}
headers = {"Content-Type": "application/json-patch+json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({
id: 123,
name: '<string>',
phone: '<string>',
email: '<string>',
segment: 123,
observation: '<string>',
registryCode: '<string>',
postalCode: '<string>',
street: '<string>',
number: '<string>',
additional: '<string>',
neighborhood: '<string>',
city: '<string>',
state: '<string>',
contactName: '<string>',
contactEmail: '<string>',
contactCellPhone: '<string>',
contactRegistryCode: '<string>',
contactBirth: '2023-11-07T05:31:56Z',
group: '<string>',
subsidiaries: 123,
cdcSaude: true,
cdcCelular: true,
epCelular: true,
cartaoLoja: true,
fgtsBmp: true,
operacaoCredito: true,
status: 123
})
};
fetch('https://api.example.com/api/services/app/Crm/CriarProspect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/services/app/Crm/CriarProspect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => 123,
'name' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'segment' => 123,
'observation' => '<string>',
'registryCode' => '<string>',
'postalCode' => '<string>',
'street' => '<string>',
'number' => '<string>',
'additional' => '<string>',
'neighborhood' => '<string>',
'city' => '<string>',
'state' => '<string>',
'contactName' => '<string>',
'contactEmail' => '<string>',
'contactCellPhone' => '<string>',
'contactRegistryCode' => '<string>',
'contactBirth' => '2023-11-07T05:31:56Z',
'group' => '<string>',
'subsidiaries' => 123,
'cdcSaude' => true,
'cdcCelular' => true,
'epCelular' => true,
'cartaoLoja' => true,
'fgtsBmp' => true,
'operacaoCredito' => true,
'status' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/services/app/Crm/CriarProspect"
payload := strings.NewReader("{\n \"id\": 123,\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"segment\": 123,\n \"observation\": \"<string>\",\n \"registryCode\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"additional\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"contactName\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"contactCellPhone\": \"<string>\",\n \"contactRegistryCode\": \"<string>\",\n \"contactBirth\": \"2023-11-07T05:31:56Z\",\n \"group\": \"<string>\",\n \"subsidiaries\": 123,\n \"cdcSaude\": true,\n \"cdcCelular\": true,\n \"epCelular\": true,\n \"cartaoLoja\": true,\n \"fgtsBmp\": true,\n \"operacaoCredito\": true,\n \"status\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/services/app/Crm/CriarProspect")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"id\": 123,\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"segment\": 123,\n \"observation\": \"<string>\",\n \"registryCode\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"additional\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"contactName\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"contactCellPhone\": \"<string>\",\n \"contactRegistryCode\": \"<string>\",\n \"contactBirth\": \"2023-11-07T05:31:56Z\",\n \"group\": \"<string>\",\n \"subsidiaries\": 123,\n \"cdcSaude\": true,\n \"cdcCelular\": true,\n \"epCelular\": true,\n \"cartaoLoja\": true,\n \"fgtsBmp\": true,\n \"operacaoCredito\": true,\n \"status\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/services/app/Crm/CriarProspect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"id\": 123,\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"segment\": 123,\n \"observation\": \"<string>\",\n \"registryCode\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"street\": \"<string>\",\n \"number\": \"<string>\",\n \"additional\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"contactName\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"contactCellPhone\": \"<string>\",\n \"contactRegistryCode\": \"<string>\",\n \"contactBirth\": \"2023-11-07T05:31:56Z\",\n \"group\": \"<string>\",\n \"subsidiaries\": 123,\n \"cdcSaude\": true,\n \"cdcCelular\": true,\n \"epCelular\": true,\n \"cartaoLoja\": true,\n \"fgtsBmp\": true,\n \"operacaoCredito\": true,\n \"status\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"segment": 123,
"observation": "<string>",
"registryCode": "<string>",
"postalCode": "<string>",
"street": "<string>",
"number": "<string>",
"additional": "<string>",
"neighborhood": "<string>",
"city": "<string>",
"state": "<string>",
"contactName": "<string>",
"contactEmail": "<string>",
"contactCellPhone": "<string>",
"contactRegistryCode": "<string>",
"contactBirth": "2023-11-07T05:31:56Z",
"group": "<string>",
"subsidiaries": 123,
"cdcSaude": true,
"cdcCelular": true,
"epCelular": true,
"cartaoLoja": true,
"fgtsBmp": true,
"operacaoCredito": true,
"status": 123
}Cria um prospect (lead). Retorna o prospect criado, com o
id. Segmento: 1 Materiais de construção, 2 Móveis e eletro, 3 Saúde, 4 Roupas e calçados, 5 Supermercados, 0 Outros.
Autentique-se antes (Autenticação). Os campos abaixo são o conteúdo de
result do envelope da API.curl -X POST "https://gateway.hubcred.com.br/external/v1/api/services/app/Crm/CriarProspect" \n -H "Authorization: Bearer SEU_TOKEN" -H "Content-Type: application/json" \n -d '{ "name": "Loja Exemplo", "phone": "11999998888", "email": "contato@exemplo.com", "segment": 1, "registryCode": "12345678000199", "status": 0 }'
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Prospect (lead comercial) para criar, atualizar e obter.
Id do prospect. Nulo ao criar; obrigatorio ao atualizar.
Segmento: 1 Materiais de construcao, 2 Moveis e eletro, 3 Saude, 4 Roupas e calcados, 5 Supermercados, 0 Outros.
CPF/CNPJ do prospect.
Status: 0 Lead, 1 Em Atendimento, 2 Ganho, 3 Perda.
Response
OK
Prospect (lead comercial) para criar, atualizar e obter.
Id do prospect. Nulo ao criar; obrigatorio ao atualizar.
Segmento: 1 Materiais de construcao, 2 Moveis e eletro, 3 Saude, 4 Roupas e calcados, 5 Supermercados, 0 Outros.
CPF/CNPJ do prospect.
Status: 0 Lead, 1 Em Atendimento, 2 Ganho, 3 Perda.