PUT /api/v1/coupons/:id: Atualizar Cupom Existente

Use este endpoint para modificar as configurações de um cupom de desconto já existente na sua loja. Você pode ajustar o valor do desconto, alterar o limite de usos, ativar ou desativar o cupom e estender ou alterar sua data de expiração. Apenas os campos enviados no body serão alterados.

Método

PUT /api/v1/coupons/:id — Requer autenticação.

Parâmetro de Rota

string

required

Identificador único do cupom a ser atualizado (ex: cpn_123).

Parâmetros do Body

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

number

Novo valor do desconto. Para cupons do tipo percentage, informe a porcentagem. Para fixed, informe o valor em reais.

number

Novo limite máximo de utilizações do cupom.

boolean

Status de ativação do cupom. Use true para ativar ou false para desativar sem excluir o cupom.

string

Nova data e hora de expiração no formato ISO 8601. Use null para remover a data de expiração.

Exemplo de Requisição

curl -X PUT 'https://api.bukiopay.com/api/v1/coupons/cpn_123' \
  --header 'Authorization: Bearer sk_live_sua_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "value": 25,
    "maxUses": 75,
    "active": true
  }'

Resposta

{
  "message": "Cupom atualizado com sucesso",
  "coupon": {
    "id": "cpn_123",
    "code": "DESCONTO10",
    "value": 25,
    "maxUses": 75,
    "active": true,
    "updatedAt": "2026-05-07T10:30:00.000Z"
  }
}

Campos da Resposta

string

Mensagem de confirmação da operação.

object

Objeto com os dados atualizados do cupom.

Show Propriedades do cupom

string

Identificador único do cupom.

string

Código do cupom (não pode ser alterado após a criação).

number

Valor atualizado do desconto.

number

Limite máximo atualizado de utilizações.

boolean

Status de ativação atualizado do cupom.

string

Data e hora da última atualização no formato ISO 8601.

Para desativar temporariamente um cupom sem excluí-lo, utilize o campo active: false. Isso preserva o histórico de utilizações e permite reativá-lo posteriormente.

Introdução à API

Cobranças PIX

Saques

Webhooks

Pedidos

Produtos

Categorias

Cupons

Loja

PUT /api/v1/coupons/:id: Atualizar Cupom Existente

Método

Parâmetro de Rota

Parâmetros do Body

Exemplo de Requisição

Resposta

Campos da Resposta

​Método

​Parâmetro de Rota

​Parâmetros do Body

​Exemplo de Requisição

​Resposta

​Campos da Resposta

Método

Parâmetro de Rota

Parâmetros do Body

Exemplo de Requisição

Resposta

Campos da Resposta