Cria uma nova campanha de loyalty. A campanha define como o cashback é gerado em um pedido —
sua alíquota (aliquot/aliquotType), gatilho, janela de validade e tipo de recompensa.
Apenas name é estritamente obrigatório pela API; os demais campos assumem defaults do sistema.
Uma campanha criada com trigger: audience-list é pareada automaticamente a um registro de
CampaignAudience, que conduz o agendamento por audiência.
Try-it values populated from environment ACME (Demo)
Send your user token in the x-guper-authorization header. Endpoints that
support a Public mode (e.g. acúmulo and resgate previews) accept the same
request without the header — Private mode adds customer data and a
confirmation token to the response.
Cabeçalhos
Name
Type
Description
x-guper-authorization
*
string
User token issued by Guper. Omit only on endpoints that explicitly support a Public mode.
Content-Type
*
string
Always `application/json` for endpoints that accept a JSON body.
Evento que dispara a campanha. Exemplos: purchase, behavioral,
member-event, external-events, audience-list. Quando for
audience-list, um CampaignAudience correspondente é criado
automaticamente. Quando for member-event, também é preciso
informar eventType.
eventType
string | null
Obrigatório quando trigger é member-event. Identifica qual
evento de ciclo de vida dispara a campanha. Valores suportados:
membership_joined — primeira adesão ao programa;
tier_achieved — cliente atingiu um nível superior.
Para outros gatilhos, deixe nulo.
type
string
Categoria da campanha (string livre interpretada pelos relatórios).
monetary | point | coupon | notification
isActive
boolean | int
Se a campanha está ativa. Campanhas inativas são ignoradas na avaliação.
isDraft
boolean | int
Rascunho: salva mas não publicada (BIT, padrão 0). Enquanto isDraft for verdadeiro a campanha nunca executa e o isActive é forçado a 0 no servidor. Publique enviando isDraft: false; campanha publicada não volta a rascunho (400).
rewardType
string
Tipo de recompensa gerada. Valores típicos: monetary, points.
monetary | point
pointsDividend
integer | null
Numerador da razão de conversão de pontos (usado quando rewardType é points).
pointsDivisor
integer | null
Denominador da razão de conversão de pontos.
aliquot
*
integer
Alíquota da recompensa. A interpretação depende de aliquotType:
0 → valor fixo em centavos por item elegível;
1 → porcentagem (5 = 5%).
aliquotType
bit (0|1)
0 = valor fixo em centavos, 1 = porcentagem.
coupon
integer | null
ID do lote de cupom associado (modelo Coupon).
recurrentByOrder
boolean | int
Quando true, a campanha pode disparar a cada pedido. Quando false, dispara apenas na primeira vez.
availabilityMode
string
Como a validade do cartão é decidida. Comuns: dateRange, delay.
consecutiveDays | dateRange
delayTime
integer (seconds) | null
Dias após a compra para o cartão ficar resgatável (quando availabilityMode for delay).
expiryTime
integer (seconds) | null
Dias contados de startsAt até o cartão expirar (quando availabilityMode for delay).
expiryPeriod
string
Optional calendar-based expiry unit, when expiry is expressed as whole weeks/months/years instead of a raw expiryTime in seconds.
week | month | year
dateRangeStart
string (date-time) | null
Data em que os cartões ficam resgatáveis (quando availabilityMode for dateRange).
dateRangeEnd
string (date-time) | null
Data de expiração dos cartões (quando availabilityMode for dateRange).
initAt
*
string (date-time)
Data em que a campanha começa a avaliar pedidos.
finishAt
*
string (date-time)
Data em que a campanha para de avaliar pedidos.
storeGroups
*
string (JSON) — required
IDs de grupos de loja em que a campanha vale. Armazenado como JSON.
segmentations
*
string (JSON) — required
Regras de segmentação aplicadas à audiência. Armazenado como JSON.
redemptionPolicy
integer | null
ID da política de resgate usada pelos cartões gerados por esta campanha.
messageSequence
string | null
ID/chave da sequência de mensagens disparada para o cliente.
campaignTag
integer | null
ID da tag no Register usada para marcar os clientes alcançados pela campanha.
rewardSegmentAdd
array | string | null
Segmentos adicionados ao cliente quando o acúmulo dispara. Armazenado como JSON.
rewardSegmentDel
array | string | null
Segmentos removidos do cliente quando o acúmulo dispara. Armazenado como JSON.
list
integer | null
ID da lista associada à campanha (lista de audiência).
reactivateWithActiveCards
boolean | int
Se a reativação deve acontecer mesmo quando o cliente ainda tem cartões ativos.
skipWithActiveCards
boolean | int
Se a elegibilidade deve ser ignorada quando o cliente já tem cartões ativos desta campanha.