Skip to main content
PATCH
Atualizar um cupom

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

couponId
integer
required

Identificador do cupom.

Required range: x > 0

Body

application/json
code
string

Código digitado no checkout; é normalizado para maiúsculas.

Required string length: 1 - 25
Pattern: ^[A-Z0-9_-]+$
discountType
enum<string>

Desconto percentual (percent) ou fixo (fixed).

Available options:
percent,
fixed
discountPercent
integer

Percentual de desconto, de 1 a 95.

Required range: 1 <= x <= 95
discountAmountInCents
integer

Desconto fixo em centavos.

Required range: x >= 1
appliesTo
enum<string>

Alcance: all, selected ou all_except.

Available options:
all,
selected,
all_except
paymentMethods
enum<string>[]

Meios de pagamento em que o cupom vale.

Minimum array length: 1

Meio de pagamento que a Ephra cobra e liquida: pix ou credit_card. boleto não é aceito na configuração — a plataforma não emite mais cobrança em boleto, apenas mantém legíveis as vendas antigas.

Available options:
pix,
credit_card
startAt
string<date-time>

Momento em que o cupom passa a valer.

expiresAt
string<date-time>

Momento em que o cupom para de valer.

maxRedemptions
integer

Teto de usos confirmados.

Required range: x >= 1
autoApply
boolean
default:false

Aplica sozinho para quem comprou o produto gatilho.

triggerProductId
string

Produto cuja compra anterior dispara o cupom automático.

triggerOfferId
integer

Oferta cuja compra anterior dispara o cupom automático.

lookbackPeriod
enum<string>

Janela da compra anterior: all, d7, d30, d60.

Available options:
all,
d7,
d30,
d60
productIds
string[]

Produtos vinculados ao cupom na criação.

Minimum string length: 1
offerIds
integer[]

Ofertas vinculadas ao cupom na criação.

Required range: x > 0

Response

Cupom atualizado.

Cupom atualizado.

success
boolean
required

Sempre true em uma resposta bem-sucedida.

data
object
required