Endpoint para criar um negócio dentro da plataforma SULTS.
URL: https://api.sults.com.br/api/v1/expansao/negocio
Método: POST
Parâmetros
Headers
Header | Valor |
---|---|
Authorization | <token_de_acesso> |
Content-Type | application/json;charset=UTF-8 |
Body Attributes
Atributos principais
Nome Atributo | Tipo | Valor |
---|---|---|
sendEmailModeloIdToLead | Integer | Identificador do modelo de e-mail para receber a notificação quando um negócio for criado. |
sendNotificationToResponsavel | Boolean | Se true o responsável por esse negócio receberá um email de notificação alertando-o que recebeu um novo lead. |
negocio | Objeto Negocio | Os atributos relacionados a esse objeto estão listados em uma tabela abaixo. Requerido |
pessoa | Objeto Pessoa | Os atributos relacionados a esse objeto estão listados em uma tabela abaixo. |
empresa | Objeto Empresa | Os atributos relacionados a esse objeto estão listados em uma tabela abaixo. |
Atributos do Objeto Negócio
Nome Atributo | Tipo | Descrição |
---|---|---|
titulo | String | Título do negócio. Requerido |
responsavelId | Integer | Identificador da pessoa responsável pelo atendimento do novo negócio. Requerido |
etapaId | Integer | Identificador da etapa onde o negócio irá ser criado no funil. Requerido |
valor | String | Valor de investimento para criar o negócio. |
cidade | String | Cidade onde será criado o negócio. |
uf | String | Estado onde será criado o negócio. |
origemId | Integer | Identificador da origem da criação do negócio. |
campanhaId | Integer | Identificador da campanha à qual o negócio será vinculado. |
temperatura | Integer referente a um dos valores abaixo: 1 – Gelado 2 – Frio 3 – Morno 4 – Quente 5 – Ardente | Identificador no qual se encontra o estado da negociação com o negócio que será criado. |
situacaoId | Integer referente a um dos valores abaixo: 1 – ABERTO 2 – GANHO 3 – PERDIDO | Identificador da situação atual do negócio criado. |
dtConclusao | String | Data em que o negócio foi concluído. |
descricao | String | Descrição do negócio. |
situacaoPerdaMotivoId | Integer | Identificador do motivo de perda do negócio. |
situacaoPerdaMotivoObservacao | String | Observação do motivo de perda do negócio. |
Atributos do Objeto Pessoa
Nome Atributo | Tipo | Descrição |
---|---|---|
nome | String | Nome da pessoa que deseja criar o negócio. |
String | E-mail da pessoa que deseja criar o negócio. | |
cidade | String | Cidade da pessoa que deseja criar o negócio. |
uf | String | Estado da pessoa que deseja criar o negócio. |
phone | String | Telefone ou Celular da pessoa que deseja criar o negócio. |
Atributos do Objeto Empresa
Nome Atributo | Tipo | Descrição |
---|---|---|
nomeFantasia | String | Nome da empresa que deseja criar o negócio. |
razaoSocial | String | Razão Social da empresa que deseja criar o negócio. |
cnpj | String | CNPJ da empresa que deseja criar o negócio. |
String | E-mail da empresa que deseja criar o negócio. | |
cidade | String | Cidade da empresa que deseja criar o negócio. |
uf | String | Estado da empresa que deseja criar o negócio. |
phone | String | Telefone ou Celular da empresa que deseja criar o negócio. |
Exemplo
Exemplo de requisição fetch em javascript para criar um negócio:
fetch("https://api.sults.com.br/api/v1/expansao/negocio", {
method: "POST",
headers: {
"Authorization": "<token_de_acesso>"
"Content-Type": "application/json;charset=UTF-8"
},
body: {
"sendEmailModeloIdToLead": 1,
"sendNotificationToResponsavel": true,
"negocio": {
"titulo": "Novo Negócio",
"responsavelId": 999,
"situacaoId": 3,
"etapaId": 9,
"descricao": "Alguma descrição",
"dtConclusao": "2022-08-07T12:03:00Z",
"valor": "R$8990,53",
"temperatura": 3,
"cidade": "Uberaba",
"uf": "MG",
"situacaoPerdaMotivoId": 1,
"situacaoPerdaMotivoObservacao": "Nao tenho mais interesse.",
"origemId": 2,
"campanhaId": 3
},
"pessoa": {
"cidade": "São Paulo",
"email": "fulano@gamil.com",
"nome": "Fulano Fulano",
"phone": "34 99999-9999",
"uf": "SP"
},
"empresa": {
"nomeFantasia": "Empresa AAAA",
"razaoSocial": "Empresa AAA Social",
"cnpj": "78751245754",
"cidade": "Sao José",
"email": "mammm@live.com",
"phone": "34 3333-3333",
"uf": "SP"
}
}
})
Resultado
Após o negócio ser inserido com sucesso é retornado o status code 200 com o id do negócio criado no corpo da resposta da requisição.
{
"id": 335
}