Pipelines e oportunidades
Pipelines, etapas, oportunidades e comentários do CRM.
O CRM em quadro da NexTags: cada pipeline tem etapas (as colunas) e oportunidades (os cartões), com o contato, o valor, o estado, a prioridade e os responsáveis. Use estas chamadas para levar ao pipeline as vendas e os atendimentos do seu sistema, mudar os cartões de etapa, fechar como ganho ou perdido e registrar comentários. O passo a passo está no guia Criar e mover oportunidades no pipeline; a tela, em O que é um pipeline.
Endpoints
/pipelinesGETConsultar pipeline/pipelines/{pipeline_id}GETListar etapas do pipeline/pipelines/{pipeline_id}/stagesGETListar campos do pipeline/pipelines/{pipeline_id}/custom_fieldsGETListar oportunidades/pipelines/{pipeline_id}/opportunitiesPOSTCriar oportunidade/pipelines/{pipeline_id}/opportunitiesGETConsultar oportunidade/pipelines/{pipeline_id}/opportunities/{opportunity_id}POSTAtualizar oportunidade/pipelines/{pipeline_id}/opportunities/{opportunity_id}DELETEApagar oportunidade/pipelines/{pipeline_id}/opportunities/{opportunity_id}POSTTransferir oportunidade de pipeline/pipelines/{pipeline_id}/opportunities/{opportunity_id}/transfer-to-pipelineGETListar comentários da oportunidade/pipelines/{pipeline_id}/opportunities/{opportunity_id}/commentsPOSTComentar na oportunidade/pipelines/{pipeline_id}/opportunities/{opportunity_id}/commentsDELETEApagar comentário/pipelines/{pipeline_id}/opportunities/{opportunity_id}/comments/{comment_id}O objeto: Oportunidade
Um cartão do pipeline: uma oportunidade de venda ou, nos pipelines de suporte, um ticket.
idintegerO ID da oportunidade.
contact_idintegerO ID do contato.
titlestringO nome da oportunidade.
descriptionstringA descrição.
valuenumberO valor, na moeda da conta. Não é em centavos: 1500 = R$ 1.500,00.
statusstringO estado: open (Aberto), won (Ganho; Resolvido nos pipelines de suporte e nos personalizados) ou lost (Perdido; Não Resolvido).
Valores: open won lost
prioritystringA prioridade: low (Baixa), medium (Média) ou high (Alta).
Valores: low medium high
stageobjectA etapa onde a oportunidade está.
stage.idintegerO ID da etapa.
stage.namestringO nome da etapa.
assigned_adminsarray de integerOs IDs dos administradores atribuídos.
created_atstringQuando a oportunidade foi criada, em UTC.
Exemplo: 2026-10-20 14:30:00
created_byintegerO ID do administrador que criou.
updated_atstringA última mudança, em UTC.
Exemplo: 2026-10-22 18:05:00
updated_byintegerO ID do administrador que fez a última mudança.
{
"id": 4201,
"contact_id": 123456789,
"title": "Plano Pro anual",
"description": "Quer começar em novembro, com 3 atendentes.",
"value": 1500,
"status": "open",
"priority": "high",
"stage": {
"id": 4101,
"name": "Novo lead"
},
"assigned_admins": [
10001
],
"created_at": "2026-10-20 14:30:00",
"created_by": 10001,
"updated_at": "2026-10-22 18:05:00",
"updated_by": 10001
}