Referência da API

Atualizar link de pagamento

Atualiza campos editáveis do QuickLink: name, slug, description, amount, validFrom, validUntil, maxUses, imageUrl, metadata e os de vitrine (successUrl, failureUrl, checkoutLogoUrl, checkoutBrandColor, checkoutLocale, metaPixelId, googleAdsId, googleAdsLabel, tiktokPixelId) — ver Personalizar o checkout. Mandar null num campo de vitrine limpa ele. Links arquivados não podem ser editados — use duplicate pra criar um novo. Lembre: editar amount afeta novas transações, mas transações já confirmadas mantêm o valor antigo.

PATCH/v2/quick-links/:id

Autenticação

HTTP Basic Auth. Envie sua secret key no header:

Authorization: Basic {base64(secret:SUA_SECRET_KEY)}

Parâmetros

idstring (path, UUID)obrigatório

UUID do QuickLink.

Exemplo: ql_a8f3d2e1-...

Body da requisição

Content-Type: application/json

JSON

{
  "name": "Doação de Natal — extensão Janeiro",
  "validUntil": "2027-01-31T23:59:59.000Z",
  "maxUses": 2000
}

Respostas

200

QuickLink atualizado. Campos omitidos ficam como estavam.

JSON

{
  "id": "ql_a8f3d2e1-...",
  "name": "Doação de Natal — extensão Janeiro",
  "slug": "doacao-natal",
  "amount": 5000,
  "validUntil": "2027-01-31T23:59:59.000Z",
  "maxUses": 2000,
  "updatedAt": "2026-05-26T16:00:00.000Z"
}

400

Causas: link arquivado, slug em uso, validUntil no passado, ou campos legacy (offerId, etc) enviados.

JSON

{
  "status": 400,
  "error": "Quick link arquivado nao pode ser editado. Use duplicate."
}

404

QuickLink não encontrado.

JSON

{ "status": 404, "error": "Quick link nao encontrado" }

Exemplos

cURL

curl -X PATCH "https://api.ihubplay.com/v2/quick-links/ql_a8f3d2e1-..." \
  -H "Authorization: Basic $(echo -n 'secret:SUA_SECRET_KEY' | base64)" \
  -H "Content-Type: application/json" \
  -d '{ "maxUses": 2000 }'