> ## Documentation Index
> Fetch the complete documentation index at: https://docs.avanttifinance.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Editar

> Atualize título, valor ou status de um link de pagamento existente

## Visão geral

Este endpoint permite atualizar parcialmente um link de pagamento já criado, como título, valor, descrição ou status (ativar/desativar).

## Endpoint

<CodeGroup>
  ```bash cURL theme={null}
  curl --request PATCH \
    --url https://api.avanttifinance.com/v1/payment-links/{payment_link_id} \
    --header "Authorization: Bearer SEU_TOKEN_DE_ACESSO" \
    --header "Content-Type: application/json" \
    --data '{
      "title": "Plano Premium - Promoção",
      "amount": 7990,
      "status": "active"
    }'
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api.avanttifinance.com/v1/payment-links/" + paymentLinkId,
    {
      method: "PATCH",
      headers: {
        Authorization: \`Bearer \${accessToken}\`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({
        title: "Plano Premium - Promoção",
        amount: 7990,
        status: "active",
      }),
    }
  );

  const link = await response.json();
  console.log(link);
  ```

  ```python Python theme={null}
  import requests

  url = f"https://api.avanttifinance.com/v1/payment-links/{payment_link_id}"
  headers = {
      "Authorization": f"Bearer {access_token}",
      "Content-Type": "application/json",
  }
  payload = {
      "title": "Plano Premium - Promoção",
      "amount": 7990,
      "status": "active",
  }

  response = requests.patch(url, headers=headers, json=payload)
  print(response.json())
  ```
</CodeGroup>

## Parâmetros de path

<ParamField path="payment_link_id" type="string" required>
  Identificador único do link de pagamento a ser atualizado.
</ParamField>

## Parâmetros do corpo

<ParamField body="title" type="string">
  Novo título exibido na página de pagamento.
</ParamField>

<ParamField body="amount" type="integer">
  Novo valor cobrado, em centavos.
</ParamField>

<ParamField body="status" type="string">
  Novo status do link: `active` ou `inactive`. Links inativos não aceitam novos pagamentos.
</ParamField>

<ParamField body="expires_at" type="string">
  Nova data de expiração do link, no formato ISO 8601.
</ParamField>

## Resposta

Retorna o objeto do link de pagamento com os dados atualizados.

```json theme={null}
{
  "id": "plink_3f8a9c1b2d",
  "title": "Plano Premium - Promoção",
  "amount": 7990,
  "status": "active",
  "url": "https://pay.avanttifinance.com/plink_3f8a9c1b2d",
  "updated_at": "2026-06-11T10:00:00Z"
}
```

<Tip>
  Para desativar um link sem excluí-lo, defina `status` como `inactive` — o link continuará existindo, mas não aceitará novos pagamentos.
</Tip>

## Erros comuns

| Código HTTP | Significado                               |
| ----------- | ----------------------------------------- |
| 400         | Dados inválidos no corpo da requisição    |
| 401         | Token de autenticação inválido ou ausente |
| 404         | Link de pagamento não encontrado          |

## Próximos passos

<CardGroup cols={2}>
  <Card title="Listar / Filtrar" icon="list" href="/listar-filtrar">
    Consulte todos os links de pagamento criados.
  </Card>

  <Card title="Criar link" icon="link" href="/criar-link">
    Crie um novo link de pagamento.
  </Card>
</CardGroup>