Atualizar oportunidade

POST/pipelines/{pipeline_id}/opportunities/{opportunity_id}

Gerada do contrato OpenAPI

Muda uma oportunidade: o título, a descrição, a etapa, o valor, o estado, a prioridade, os responsáveis e os campos do pipeline. Para mudar de etapa, mande o stage_id novo; para fechar, o status com won (ganha) ou lost (perdida); para reabrir, open. O title vai sempre, mesmo quando não muda. Veja Valor, prioridade, vencimento e responsáveis.

Requisição

curl -X POST "https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Plano Pro anual",
    "stage_id": 4103,
    "status": "won",
    "value": 1800,
    "custom_fields": [
      {
        "name": "Origem do lead",
        "value": "Indicação"
      }
    ]
  }'

const resposta = await fetch('https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201', {
  method: 'POST',
  headers: {
    'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Plano Pro anual',
    stage_id: 4103,
    status: 'won',
    value: 1800,
    custom_fields: [
      {
        name: 'Origem do lead',
        value: 'Indicação',
      },
    ],
  }),
});
const dados = await resposta.json();
console.log(resposta.status, dados);

import os

import requests

resposta = requests.post(
    "https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201",
    headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
    json={
        "title": "Plano Pro anual",
        "stage_id": 4103,
        "status": "won",
        "value": 1800,
        "custom_fields": [
            {
                "name": "Origem do lead",
                "value": "Indicação",
            },
        ],
    },
    timeout=30,
)
print(resposta.status_code, resposta.json())

<?php
$ch = curl_init('https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'title' => 'Plano Pro anual',
        'stage_id' => 4103,
        'status' => 'won',
        'value' => 1800,
        'custom_fields' => [
            [
                'name' => 'Origem do lead',
                'value' => 'Indicação',
            ],
        ],
    ]),
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);

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).

opportunity_idintegerobrigatório

O ID da oportunidade (veja Listar oportunidades).

Corpo da requisição

JSONContent-Type: application/json

titlestringobrigatório

O nome da oportunidade. Vai sempre: mande o atual quando não for mudar.

descriptionstring

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

stage_idinteger

O ID da etapa para onde a oportunidade vai.

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 foi atualizada.

successboolean

true quando deu certo.

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.

curl -X POST "https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201" \ -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "title": "Plano Pro anual", "stage_id": 4103, "status": "won", "value": 1800, "custom_fields": [ { "name": "Origem do lead", "value": "Indicação" } ] }'

const resposta = await fetch('https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201', { method: 'POST', headers: { 'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY, 'Content-Type': 'application/json', }, body: JSON.stringify({ title: 'Plano Pro anual', stage_id: 4103, status: 'won', value: 1800, custom_fields: [ { name: 'Origem do lead', value: 'Indicação', }, ], }), }); const dados = await resposta.json(); console.log(resposta.status, dados);

import os import requests resposta = requests.post( "https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201", headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]}, json={ "title": "Plano Pro anual", "stage_id": 4103, "status": "won", "value": 1800, "custom_fields": [ { "name": "Origem do lead", "value": "Indicação", }, ], }, timeout=30, ) print(resposta.status_code, resposta.json())

<?php $ch = curl_init('https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => [ 'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'), 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => json_encode([ 'title' => 'Plano Pro anual', 'stage_id' => 4103, 'status' => 'won', 'value' => 1800, 'custom_fields' => [ [ 'name' => 'Origem do lead', 'value' => 'Indicação', ], ], ]), ]); $dados = json_decode(curl_exec($ch), true); echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL; print_r($dados);

Autenticação

Parâmetros de caminho

Corpo da requisição

Respostas

Relacionados

Criar e mover oportunidades no pipeline

Oportunidades e tickets: criar, mover, ganhar e perder

Valor, prioridade, vencimento e responsáveis

Automações ao mudar de etapa

Listar pipelines

Consultar pipeline