> ## Documentation Index
> Fetch the complete documentation index at: https://developers.sults.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar negócio

> Cria um negócio (lead) dentro da plataforma do SULTS.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/expansao/negocio
openapi: 3.1.0
info:
  title: API SULTS
  version: v1
  description: >-
    API REST do SULTS. Todas as chamadas devem ser autenticadas por um token
    enviado, puro e sem o prefixo `Bearer`, no cabeçalho HTTP `Authorization`.
    As datas seguem o formato UTC ISO 8601 (`yyyy-MM-ddTHH:mm:ssZ`) e campos com
    máscara (CNPJ, telefone, CEP etc.) são retornados sem máscara. Endpoints de
    listagem paginados aceitam os parâmetros `start` e `limit`.
  contact:
    name: Suporte SULTS
    url: https://ajuda.sults.com.br
servers:
  - url: https://api.sults.com.br
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: Unidades
    description: >-
      Unidades da rede e colaboradores ativos cadastrados no SULTS. Somente
      leitura: a API não grava unidades nem colaboradores. A API do SULTS é REST
      sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho
      `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado
      por um administrador na plataforma, em Segurança > API > Gestão de Tokens
      v1. O limite é de 2 requisições por segundo, por IP.
  - name: Chamados
    description: >-
      Chamados abertos na plataforma e a timeline de cada um, com os endpoints
      de criação e conclusão. A API do SULTS é REST sobre HTTPS e responde em
      JSON. Cada requisição leva o token no cabeçalho `Authorization`, enviado
      puro, sem o prefixo `Bearer`. O token é gerado por um administrador na
      plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2
      requisições por segundo, por IP.
  - name: Checklist
    description: >-
      Avaliações de checklist aplicadas nas unidades, com respostas, check-ins,
      check-outs e planos de ação. A API do SULTS é REST sobre HTTPS e responde
      em JSON. Cada requisição leva o token no cabeçalho `Authorization`,
      enviado puro, sem o prefixo `Bearer`. O token é gerado por um
      administrador na plataforma, em Segurança > API > Gestão de Tokens v1. O
      limite é de 2 requisições por segundo, por IP.
  - name: Compras
    description: >-
      Pedidos de compra e catálogo de produtos da v1, incluindo o cadastro e a
      edição de produto e a edição de pedido. A v1 de Compras não recebe novas
      funcionalidades: mix de produtos, etapas de pedido e as próximas novidades
      do módulo estão só na API v2, que é a indicada para integrações novas de
      Compras. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada
      requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o
      prefixo `Bearer`. O token é gerado por um administrador na plataforma, em
      Segurança > API > Gestão de Tokens v1. O limite é de 2 requisições por
      segundo, por IP.
  - name: implantacao
    description: >-
      Projetos de implantação de novas unidades e as tarefas de cada projeto. A
      API do SULTS é REST sobre HTTPS e responde em JSON. Cada requisição leva o
      token no cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`.
      O token é gerado por um administrador na plataforma, em Segurança > API >
      Gestão de Tokens v1. O limite é de 2 requisições por segundo, por IP.
    x-group: Implantação
  - name: Projetos
    description: >-
      Projetos da operação e as tarefas vinculadas a eles. A API do SULTS é REST
      sobre HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho
      `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado
      por um administrador na plataforma, em Segurança > API > Gestão de Tokens
      v1. O limite é de 2 requisições por segundo, por IP.
  - name: expansao
    description: >-
      Negócios do funil de Expansão e a timeline de cada um, com o endpoint de
      criação de negócio. A API do SULTS é REST sobre HTTPS e responde em JSON.
      Cada requisição leva o token no cabeçalho `Authorization`, enviado puro,
      sem o prefixo `Bearer`. O token é gerado por um administrador na
      plataforma, em Segurança > API > Gestão de Tokens v1. O limite é de 2
      requisições por segundo, por IP.
    x-group: Expansão
paths:
  /api/v1/expansao/negocio:
    post:
      tags:
        - expansao
      summary: Criar negócio
      description: Cria um negócio (lead) dentro da plataforma do SULTS.
      operationId: criarNegocio
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NegocioCriacao'
      responses:
        '200':
          description: Negócio criado com sucesso. Retorna o id do negócio criado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: Código do negócio criado
              example:
                id: 335
        '400':
          $ref: '#/components/responses/ErroValidacao'
        '401':
          $ref: '#/components/responses/TokenInvalido'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '429':
          $ref: '#/components/responses/LimiteDeRequisicoes'
        5XX:
          $ref: '#/components/responses/ErroDoServidor'
components:
  schemas:
    NegocioCriacao:
      type: object
      required:
        - negocio
      properties:
        sendEmailModeloIdToLead:
          type: integer
          description: >-
            Identificador do modelo de e-mail que o lead receberá como
            notificação quando o negócio for criado
          example: 1
        sendNotificationToResponsavel:
          type: boolean
          description: >-
            Se `true`, o responsável por esse negócio receberá um e-mail de
            notificação alertando que recebeu um novo lead
          example: true
        negocio:
          type: object
          description: Dados do negócio
          required:
            - titulo
            - responsavelId
            - etapaId
          properties:
            titulo:
              type: string
              description: Título do negócio
              example: Nova unidade em Belo Horizonte
            responsavelId:
              type: integer
              description: >-
                Identificador da pessoa responsável pelo atendimento do novo
                negócio
              example: 5
            etapaId:
              type: integer
              description: Identificador da etapa onde o negócio será criado no funil
              example: 5
            valor:
              type: number
              description: Valor de investimento para criar o negócio
              example: 24.9
            cidade:
              type: string
              description: Cidade onde será criado o negócio
              example: Uberaba
            uf:
              type: string
              description: Estado onde será criado o negócio
              example: MG
            origemId:
              type: integer
              description: Identificador da origem da criação do negócio
              example: 5
            campanhaId:
              type: integer
              description: Identificador da campanha à qual o negócio será vinculado
              example: 5
            temperatura:
              type: integer
              enum:
                - 1
                - 2
                - 3
                - 4
                - 5
              description: |-
                Temperatura do negócio.

                | Valor | Significado |
                | ----- | ----------- |
                | 1 | Gelado |
                | 2 | Frio |
                | 3 | Morno |
                | 4 | Quente |
                | 5 | Ardente |
              example: 1
            situacaoId:
              type: integer
              enum:
                - 1
                - 2
                - 3
              description: |-
                Situação atual do negócio.

                | Valor | Significado |
                | ----- | ----------- |
                | 1 | Aberto |
                | 2 | Ganho |
                | 3 | Perdido |
              example: 1
            dtConclusao:
              type: string
              format: date-time
              description: Data em que o negócio foi concluído (UTC ISO 8601)
              example: '2026-10-10T17:00:00Z'
            descricao:
              type: string
              description: Descrição do negócio
              example: Item padrão do checklist de abertura.
            situacaoPerdaMotivoId:
              type: integer
              description: Identificador do motivo de perda do negócio
              example: 5
            situacaoPerdaMotivoObservacao:
              type: string
              description: Observação do motivo de perda do negócio
              example: Candidato decidiu adiar o investimento para 2027
        pessoa:
          type: object
          description: Pessoa de contato do lead
          properties:
            nome:
              type: string
              description: Nome da pessoa que deseja criar o negócio
              example: Marcos Tavares
            email:
              type: string
              description: E-mail da pessoa
              example: operacoes@sabormineiro.com.br
            cidade:
              type: string
              description: Cidade da pessoa
              example: Uberaba
            uf:
              type: string
              description: Estado da pessoa
              example: MG
            phone:
              type: string
              description: Telefone ou celular da pessoa
              example: '34988776655'
        empresa:
          type: object
          description: Empresa de contato do lead
          properties:
            nomeFantasia:
              type: string
              description: Nome da empresa que deseja criar o negócio
              example: Tavares Investimentos
            razaoSocial:
              type: string
              description: Razão social da empresa
              example: SULTS Tecnologia LTDA
            cnpj:
              type: string
              description: CNPJ da empresa
              example: '12345678000190'
            email:
              type: string
              description: E-mail da empresa
              example: operacoes@sabormineiro.com.br
            cidade:
              type: string
              description: Cidade da empresa
              example: Uberaba
            uf:
              type: string
              description: Estado da empresa
              example: MG
            phone:
              type: string
              description: Telefone ou celular da empresa
              example: '34988776655'
    Erro:
      type: object
      description: >-
        Corpo padrão de erro da API. Não existe código de erro interno: decida a
        sua lógica pelo status HTTP e use a mensagem apenas para logs e
        diagnóstico.
      required:
        - error
      properties:
        error:
          type: string
          description: >-
            Mensagem legível, em português, descrevendo a falha. O texto pode
            mudar: nunca o use como condição de código.
          example: Campo responsavel não pode ser vazio ou nulo.
  responses:
    ErroValidacao:
      description: >-
        Erro de validação ou formato errado nos dados de entrada. A API aponta
        **um campo por vez**: corrija o campo indicado na mensagem, reenvie e
        repita até o 200.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
          example:
            error: Campo responsavel não pode ser vazio ou nulo.
    TokenInvalido:
      description: >-
        Token ausente ou inválido. Confira: copiado por completo, cabeçalho
        `Authorization` com o nome exato, valor sem o prefixo `Bearer` e gerado
        na **Gestão de Tokens v1** (tokens v2 não funcionam nesta API). Sem
        retry automático. O corpo real é `{"error": "Acesso não autorizado."}`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
          example:
            error: Acesso não autorizado.
    NaoEncontrado:
      description: >-
        Recurso ou entidade inexistente (por exemplo, um `{id}` do caminho que
        não existe ou foi excluído no SULTS). Reenviar sem corrigir devolve o
        mesmo erro.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
    LimiteDeRequisicoes:
      description: >-
        Limite de requisições excedido: **2 requisições por segundo, por IP**. A
        resposta é a página HTML padrão do servidor, não JSON, e não há o header
        `Retry-After`: trate pelo status 429, sem fazer parse do corpo, com
        espera crescente a partir de 1 segundo.
      content:
        text/html:
          schema:
            type: string
            description: >-
              Página HTML padrão do servidor. Não faça parse; decida pelo
              status.
    ErroDoServidor:
      description: >-
        Falha inesperada do servidor (raro). Repita com espera crescente;
        persistindo, acione o suporte com data, hora e endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token  gerado através do sistema do SULTS. Deve ser enviado no cabeçalho
        `Authorization` de todas as requisições.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.