Skip to main content
PATCH
/
api
/
v1
/
public
/
coupons
/
{uid}
/
use
Usar cupom
curl --request PATCH \
  --url https://api.indiqai.com/api/v1/public/coupons/{uid}/use \
  --header 'X-API-Key: <x-api-key>'
{
  "uid": "CPN-A1B2C3D4",
  "status": "used",
  "used_at": "2026-03-20T14:30:00Z",
  "message": "Cupom utilizado com sucesso"
}

​
Usar Cupom

Marca um cupom válido como utilizado. Apenas cupons com status valid podem ser marcados como usados.

​
Path Parameters

​
uid
string
required
Código único do cupom (ex: CPN-A1B2C3D4)

​
Request

curl -X PATCH "https://api.indiqai.com/api/v1/public/coupons/CPN-A1B2C3D4/use" \
  -H "X-API-Key: indiqai_sua_chave_aqui"

​
Response

{
  "uid": "CPN-A1B2C3D4",
  "status": "used",
  "used_at": "2026-03-20T14:30:00Z",
  "message": "Cupom utilizado com sucesso"
}

​
Campos da Resposta

​
uid
string
Código único do cupom
​
status
string
Novo status do cupom: used
​
used_at
string
Data e hora do uso (ISO 8601)
​
message
string
Mensagem de confirmação

Headers

​
X-API-Key
string
required

Chave de API da empresa

Path Parameters

​
uid
string
required

Response

Successful Response

Dados de um cupom.

​
status
string
required
​
uid
string
required
​
created_at
string<date-time> | null
​
expires_at
string<date-time> | null
​
product_name
string | null
​
valor
number | null