Skip to main content
PATCH
/
links
/
{id}
curl --request PATCH \
  --url https://api.pagozz.com/v1/links/{id} \
  --header 'Content-Type: application/json' \
  --header 'Pagozz-Token: <api-key>' \
  --data '
{
  "name": "Consultoria 2h",
  "description": "Sessão estendida de consultoria"
}
'
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Consultoria 2h",
    "description": "Sessão estendida de consultoria",
    "value_mode": "fixed",
    "amount": 20000,
    "min_amount": null,
    "currency": "BRL",
    "status": "active",
    "payment_methods": [
      "pix"
    ],
    "environment": "test",
    "created_at": "2026-02-20T10:30:00Z",
    "updated_at": "2026-02-27T15:00:00Z"
  }
}

Authorizations

​
Pagozz-Token
string
header
required

Chave de API no formato pgz_test_* (test mode) ou pgz_live_* (live mode). O ambiente é determinado automaticamente pelo prefixo da chave.

Path Parameters

​
id
string<uuid>
required

ID do link (UUID).

Body

application/json

Todos os campos são opcionais. Envie apenas os que deseja alterar.

​
name
string

Opcional. Novo nome do link.

Required string length: 1 - 100
​
description
string | null

Opcional. Nova descrição. Envie null para remover.

Maximum string length: 500
​
value_mode
enum<string>

Opcional. Novo modo de valor.

Available options:
fixed,
free,
minimum
​
amount
integer | null

Opcional. Novo valor em centavos.

​
min_amount
integer | null

Opcional. Novo valor mínimo em centavos.

​
expires_in
integer

Opcional. Novo tempo de expiração em segundos.

Required range: 60 <= x <= 86400
​
status
enum<string>

Opcional. Ativar ou desativar o link.

Available options:
active,
inactive
​
checkout_field_full_name
enum<string>

Opcional.

Available options:
disabled,
optional,
required
​
checkout_field_cnpj
enum<string>

Opcional.

Available options:
disabled,
optional,
required
​
checkout_field_company_name
enum<string>

Opcional.

Available options:
disabled,
optional,
required
​
checkout_field_phone
enum<string>

Opcional.

Available options:
disabled,
optional,
required
​
checkout_field_address
enum<string>

Opcional.

Available options:
disabled,
optional,
required
​
success_redirect_url
string<uri> | null

Opcional. URL HTTPS de redirecionamento. Envie null para remover.

​
callback_url
string<uri> | null

Opcional. URL HTTPS de callback. Envie null para remover.

Response

Link atualizado com sucesso.

​
data
object

Representa um link de pagamento.