# Transferir oportunidade de pipeline

> Leva a oportunidade para outro pipeline, numa etapa escolhida, como o Transferir para o Pipeline do cartão.

Endereço: https://docs.nextags.com.br/referencia/pipelines/transferir-oportunidade-de-pipeline/
Tipo: Endpoint

```http
POST https://app.nextagsai.com.br/api/pipelines/{pipeline_id}/opportunities/{opportunity_id}/transfer-to-pipeline
X-ACCESS-TOKEN: <sua chave de API>
```

Leva a oportunidade para outro pipeline, numa etapa escolhida, como o **Transferir para o Pipeline** do cartão. A etapa é do pipeline de destino: pegue o ID dela em [Listar etapas do pipeline](https://docs.nextags.com.br/referencia/pipelines/listar-etapas-do-pipeline/), com o ID do pipeline novo. Veja [Oportunidades e tickets](https://help.nextags.com.br/tutoriais/pipelines/oportunidades/).

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](https://docs.nextags.com.br/comecar/autenticacao/).

## Parâmetros de caminho

| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `pipeline_id` | integer | sim | O ID do pipeline onde a oportunidade está agora. |
| `opportunity_id` | integer | sim | O ID da oportunidade (veja [Listar oportunidades](https://docs.nextags.com.br/referencia/pipelines/listar-oportunidades/)). |

## Corpo da requisição (JSON)

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `target_pipeline_id` | integer | sim | O ID do pipeline de destino. |
| `target_stage_id` | integer | sim | O ID da etapa do pipeline de destino onde a oportunidade entra. |

```json
{
  "target_pipeline_id": 4002,
  "target_stage_id": 4111
}
```

## Exemplo

```bash
curl -X POST "https://app.nextagsai.com.br/api/pipelines/4001/opportunities/4201/transfer-to-pipeline" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target_pipeline_id": 4002,
    "target_stage_id": 4111
  }'
```

Os exemplos em JavaScript, Python e PHP estão na página e no contrato (`x-codeSamples` em https://docs.nextags.com.br/openapi.json).

## Respostas

### 200 Sucesso

A oportunidade mudou de pipeline.

| Campo | Tipo | Descrição |
|---|---|---|
| `success` | boolean | `true` quando deu certo. |

```json
{
  "success": true
}
```

### 401 Chave 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](https://docs.nextags.com.br/comecar/autenticacao/).

```json
{
  "error": {
    "code": 401,
    "message": "No valid API key provided."
  }
}
```