Negócios do Pipeline

Criar Negócio do Pipeline

Cria um novo negócio no pipeline de CRM da conta autenticada, com suporte a vinculação de produtos e cálculo automático de valores.

POST/account-crm-pipeline-deal
curl --request POST \
  --url 'https://crm.wavups.com/api/v1/account-crm-pipeline-deal' \
  --header 'Token: SEU_TOKEN_DE_API' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Contrato Anual - Empresa XPTO",
    "stageId": "cmkfy4kdk0009y0c1qx9fgumt",
    "leadId": "cmsncjkqw0bzx0hll2lv5i34a",
    "dealOwner": "cmuser0012345",
    "currency": "USD",
    "expectedClose": "2026-09-30T00:00:00.000Z",
    "customFields": {
      "orcamento": "2.000,00"
    },
    "products": [
      {
        "productId": "cmprod001",
        "quantity": 2,
        "discount": 50,
        "discountType": "PERCENTAGE"
      }
    ]
  }'
{
  "id": "cldeal002",
  "customFields": {
    "orcamento": 2000
  },
  "stageId": "cmkfy4kdk0009y0c1qx9fgumt",
  "leadId": "cmsncjkqw0bzx0hll2lv5i34a",
  "dealOwner": "cmuser0012345",
  "title": "Contrato Anual - Empresa XPTO",
  "description": null,
  "value": 1500.0,
  "status": "open",
  "currency": "USD",
  "lossReasonId": null,
  "lossNote": null,
  "type": null,
  "nextAction": null,
  "source": null,
  "probability": 0,
  "order": 0,
  "expectedClose": "2026-09-30T00:00:00.000Z",
  "wonAt": null,
  "lostAt": null,
  "createdAt": "2026-08-20T10:00:00.000Z",
  "AccountCRMLead": {
    "id": "cmsncjkqw0bzx0hll2lv5i34a",
    "name": "Gabriel Cerrini",
    "email": "gabriel@email.com",
    "phone": "+5511999998888"
  },
  "AccountUser": {
    "id": "cmuser0012345",
    "User": {
      "name": "Vendedor Proativia",
      "email": "vendedor@empresa.com"
    }
  },
  "AccountCRMPipelineStage": {
    "id": "cmkfy4kdk0009y0c1qx9fgumt",
    "name": "1ºContato",
    "pipelineId": "cmkfy4k700008y0c1phx38422"
  },
  "accountCRMPipelineDealProductAssignments": [
    {
      "id": "cpassign002",
      "accountProductId": "cmprod001",
      "quantity": 2,
      "discount": 50,
      "discountType": "PERCENTAGE",
      "totalPrice": 1500.0,
      "createdAt": "2026-08-20T10:00:00.000Z",
      "AccountProduct": {
        "id": "cmprod001",
        "name": "Plano Anual Consultoria",
        "price": 1500.0,
        "description": "Consultoria continuada para vendas"
      }
    }
  ]
}

Requisição

POST https://crm.wavups.com/api/v1/account-crm-pipeline-deal

Tokenstringobrigatório

Seu token de autenticação.

Body

titlestringobrigatório

Título do negócio.

stageIdstringobrigatório

ID do estágio do pipeline ao qual o negócio pertence.

leadIdstring

ID do lead a ser vinculado ao negócio.

dealOwnerstring

ID do usuário responsável pelo negócio.

valuenumber

Valor estimado do negócio. Se omitido e produtos forem vinculados, o valor será calculado automaticamente pela soma dos produtos.

statusstring

Status do negócio: open, won ou lost. Padrão: open. Outro valor responde 400.

A etapa manda no status. Se o stageId for uma etapa de ganho ou de perdido (definidas em Pipelines > Etapas de ganho e perdido, na plataforma), o negócio já nasce won ou lost, mesmo que você envie outro status. Se você enviar won ou lost com uma etapa em andamento, o negócio vai para a primeira etapa de ganho ou de perdido do pipeline (se o pipeline tiver uma).

wonAtstring

Data real do ganho, em ISO 8601 (2026-10-06 ou 2026-10-06T14:30:00Z). Só vale quando o negócio nasce ganho. Se omitida, a data do ganho é o momento da criação. Use para registrar uma venda que já aconteceu. Não pode ser no futuro (400).

lostAtstring

Data real da perda, em ISO 8601. Mesma regra do wonAt, para negócios que nascem perdidos: se omitida, vale o momento da criação.

Motivo da perda: o ID de um motivo cadastrado na plataforma, o mesmo que aparece em lossReasonId nos negócios perdidos. Só vale quando o negócio nasce perdido. ID que não é da conta responde 404.

lossNotestring

Observação da perda (até 1000 caracteres). Só vale quando o negócio nasce perdido.

currencystring

Moeda do valor: código ISO 4217 de 3 letras, como BRL, USD, EUR, GBP ou JPY (aceito também em minúsculas: usd vira USD). Padrão: BRL. Código desconhecido responde 400.

typestring

Tipo ou categoria do negócio.

Próxima ação prevista para o negócio.

sourcestring

Origem do negócio (ex: site, indicacao, whatsapp).

Campos personalizados do negócio, pela chave do campo (os campos de negócio são por pipeline; veja a chave em Pipelines > Campos, na plataforma). Exemplo: { "origem_da_proposta": "Indicação", "orcamento": "1.500,50" }.

  • Só valem os campos do pipeline da etapa em que o negócio fica.
  • Seleção: o nome ou o id da opção. Seleção múltipla: uma lista de nomes.
  • Número e moeda: 1500 ou 1.500,50. Data: 2026-03-15 ou 15/03/2026. Sim/Não: true/false ou sim/não.
  • Chave desconhecida, de outro pipeline ou valor inválido responde 400 e nada é gravado. Campos obrigatórios não são exigidos por esta API.

Probabilidade de fechamento em percentual (0 a 100). Padrão: 0.

ordernumber

Ordem de exibição na coluna do estágio. Padrão: 0.

Data prevista de fechamento no formato ISO 8601 (ex: 2026-09-15T00:00:00.000Z).

Lista de produtos a serem vinculados ao negócio.


Resposta

Retorna o objeto completo do negócio criado com todos os relacionamentos e produtos vinculados.

idstring

Identificador único do negócio criado.

stageIdstring

ID do estágio vinculado.

leadIdstring | null

ID do lead vinculado.

dealOwnerstring | null

ID do usuário responsável.

titlestring

Título do negócio.

descriptionstring | null

Descrição do negócio.

valuenumber | null

Valor total do negócio.

statusstring

Status do negócio.

expectedClosestring | null

Data prevista de fechamento (ISO 8601).

wonAtstring | null

Data do ganho (ISO 8601). Preenchida quando o negócio é ganho: a data informada ou o momento da criação.

lostAtstring | null

Data da perda (ISO 8601). Preenchida quando o negócio é perdido.

Campos personalizados preenchidos do negócio (só os do pipeline dele), pela chave do campo. Seleção traz o nome da opção; sem nenhum valor, vem {}.

currencystring

Moeda do valor: código ISO 4217 de 3 letras (ex: BRL, USD, EUR). Negócio sem moeda gravada vem como BRL. O value está sempre nessa moeda.

lossReasonIdstring | null

Motivo da perda escolhido na plataforma (só em negócios perdidos).

lossNotestring | null

Observação da perda (só em negócios perdidos).

createdAtstring

Data de criação (ISO 8601).

AccountCRMLeadobject | null

Dados do lead associado ao negócio.

AccountUserobject | null

Dados do responsável pelo negócio.

Dados do estágio associado ao negócio.

Produtos vinculados ao negócio.


Autorização

Tokenstring · headerobrigatório

Token de autenticacao gerado na plataforma WavUps CRM.

Corpo da requisição

application/json · object
titlestringobrigatório

Titulo do negocio.

stageIdstringobrigatório

ID do estagio em que o negocio se encontra.

leadIdstring

ID do lead vinculado ao negocio.

dealOwnerstring

ID do usuario responsavel pelo negocio.

Descricao do negocio.

valuenumber

Valor estimado do negocio.

statusenum<string>

Status do negocio. Padrao: open. A etapa manda: criado numa etapa de ganho ou de perdido, o negocio ja nasce won ou lost (o status enviado e ignorado). Enviado como won ou lost para uma etapa em andamento, o negocio vai para a primeira etapa de ganho ou de perdido do pipeline, se houver.

Valores aceitos: open, won, lost

typestring

Tipo do negocio.

Proxima acao prevista.

Campos personalizados do negócio, pela chave do campo. Só valem os campos do pipeline da etapa em que o negócio fica (na atualização, a etapa de destino quando o negócio muda de etapa). Seleção aceita o nome ou o id da opção; números aceitam `1500` ou `1.500,50`; datas, `2026-03-15` ou `15/03/2026`; Sim/Não, `true`/`false` ou `sim`/`não`. Chave desconhecida, de outro pipeline ou valor inválido responde `400` e nada é gravado. Na atualização, `null` ou texto vazio limpa o campo e os campos não enviados ficam como estão.

Exemplo:
{
  "origem_da_proposta": "Indicação",
  "orcamento": "1.500,50"
}
sourcestring

Origem do negocio.

Probabilidade de fechamento em percentual (0 a 100).

orderinteger

Posicao de ordenacao.

expectedClosestring<date-time>

Data prevista de fechamento (ISO 8601).

wonAtstring

Data real do ganho (ISO 8601, ex: 2026-10-06 ou 2026-10-06T14:30:00Z). So vale quando o negocio fica ganho. Se omitida, a data do ganho e o momento da criacao (ou da mudanca para ganho). Nao pode ser no futuro.

lostAtstring

Data real da perda (ISO 8601). So vale quando o negocio fica perdido. Se omitida, a data da perda e o momento da criacao (ou da mudanca para perdido). Nao pode ser no futuro.

currencystring

Moeda do valor do negocio: codigo ISO 4217 de 3 letras (BRL, USD, EUR, GBP, JPY...), aceito tambem em minusculas. Padrao: BRL. Codigo desconhecido responde 400.

Exemplo: "BRL"

ID de um motivo de perda cadastrado na plataforma (o mesmo de lossReasonId nos negocios perdidos). So vale quando o negocio fica perdido. ID que nao e da conta responde 404.

lossNotestring

Observacao da perda (ate 1000 caracteres). So vale quando o negocio fica perdido.

productsobject[]

Lista de produtos vinculados ao negocio.

Respostas

201application/json · object

Negócio criado com sucesso.

idstring
stageIdstring
leadIdstring | null
dealOwnerstring | null
titlestring
descriptionstring | null
valuenumber | null
statusstring
typestring | null
nextActionstring | null

Campos personalizados do negócio preenchidos, pela chave do campo (os campos do negócio são por pipeline: só aparecem os do pipeline do negócio). Seleção traz o nome da opção; seleção múltipla, uma lista de nomes. Sem valores, vem {}.

Exemplo:
{
  "origem_da_proposta": "Indicação",
  "orcamento": 1500
}
sourcestring | null
orderinteger
expectedClosestring<date-time> | null
wonAtstring<date-time> | null
lostAtstring<date-time> | null
currencystring

Moeda do valor do negocio: codigo ISO 4217 de 3 letras (BRL, USD, EUR, GBP, JPY...), aceito tambem em minusculas. Padrao: BRL. Codigo desconhecido responde 400.

Exemplo: "BRL"
lossReasonIdstring | null

ID do motivo da perda escolhido na plataforma (so em negocios perdidos).

lossNotestring | null

Observacao da perda (so em negocios perdidos).

createdAtstring<date-time>
AccountCRMLeadobject | null
AccountUserobject | null
500