Pular para o conteúdo
Acessar conta

Criar oportunidade

POST/pipelines/{pipeline_id}/opportunities
Gerada do contrato OpenAPI

Cria uma oportunidade (ou um ticket, nos pipelines de suporte) para um contato. Sem stage_id, ela entra na primeira etapa do pipeline. Os IDs vêm de Listar etapas do pipeline, Listar administradores e Listar campos do pipeline. Veja o guia Criar e mover oportunidades no pipeline.

Requisição
curl -X POST "https://app.nextagsai.com.br/api/pipelines/4001/opportunities" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": 123456789,
    "title": "Plano Pro anual",
    "description": "Quer começar em novembro, com 3 atendentes.",
    "stage_id": 4101,
    "value": 1500,
    "status": "open",
    "priority": "high",
    "assigned_admins": [
      10001
    ],
    "custom_fields": [
      {
        "id": 3201,
        "value": "Anúncio no Instagram"
      }
    ]
  }'

Autenticação

Mande a chave de API da conta no cabeçalho X-ACCESS-TOKEN de cada chamada. Veja Autenticação com a chave de API.

Parâmetros de caminho

pipeline_idintegerobrigatório

O ID do pipeline (veja Listar pipelines).

Corpo da requisição

JSONContent-Type: application/json

contact_idintegerobrigatório

O ID do contato dono da oportunidade.

titlestringobrigatório

O nome da oportunidade (o Nome da Oportunidade da tela), como "Plano Pro anual".

descriptionstring

A descrição (a Descrição da Oportunidade).

stage_idinteger

O ID da etapa onde a oportunidade entra. Sem ele, a primeira etapa do pipeline.

valuenumber

O Valor da Oportunidade, na moeda da conta. Não é em centavos: 1500 = R$ 1.500,00.

Padrão: 0

statusstring

O Estado: open (Aberto), won (Ganho) ou lost (Perdido). Nos pipelines de suporte e nos personalizados, won aparece como Resolvido e lost como Não Resolvido.

Valores: open won lost

Padrão: open

prioritystring

A Prioridade: low (Baixa), medium (Média) ou high (Alta).

Valores: low medium high

Padrão: medium

assigned_adminsarray de integer

Os Administradores atribuídos: uma lista de IDs de administradores (veja Listar administradores).

Padrão: []

custom_fieldsarray de object

Os valores dos campos do pipeline (veja Listar campos do pipeline). Cada item leva o id ou o name do campo e o value.

custom_fields[].idinteger

O ID do campo do pipeline.

custom_fields[].namestring

O nome do campo do pipeline, no lugar do id.

custom_fields[].valuestring ou number

O valor do campo: texto ou número, conforme o tipo.

Respostas

200Sucesso

A oportunidade criada, em data.

Ver os 16 campos
dataarray de objeto Oportunidade

Uma lista com a oportunidade criada.

data[].idinteger

O ID da oportunidade.

data[].contact_idinteger

O ID do contato.

data[].titlestring

O nome da oportunidade.

data[].descriptionstring

A descrição.

data[].valuenumber

O valor, na moeda da conta. Não é em centavos: 1500 = R$ 1.500,00.

data[].statusstring

O estado: open (Aberto), won (Ganho; Resolvido nos pipelines de suporte e nos personalizados) ou lost (Perdido; Não Resolvido).

Valores: open won lost

data[].prioritystring

A prioridade: low (Baixa), medium (Média) ou high (Alta).

Valores: low medium high

data[].stageobject

A etapa onde a oportunidade está.

data[].stage.idinteger

O ID da etapa.

data[].stage.namestring

O nome da etapa.

data[].assigned_adminsarray de integer

Os IDs dos administradores atribuídos.

data[].created_atstring

Quando a oportunidade foi criada, em UTC.

Exemplo: 2026-10-20 14:30:00

data[].created_byinteger

O ID do administrador que criou.

data[].updated_atstring

A última mudança, em UTC.

Exemplo: 2026-10-22 18:05:00

data[].updated_byinteger

O ID do administrador que fez a última mudança.

401Chave inválida

A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja Autenticação.

Relacionados

Este conteúdo ajudou?

Obrigado! Sua resposta ajuda a melhorar a central.