Entrar

Criar campanha

POST https://{organization}.myguper.com/api/loyalty/campaign

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)


Autenticação

Token

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.

Corpo da requisição

Content-Type: application/json

{
    "name": "Aniversário — 10% cashback",
    "displayName": "Feliz aniversário!",                        // optional
    "beneficiaryType": "buyer",                                 // optional, referrer | buyer
    "trigger": "purchase",                                      // optional
    "eventType": "tier_achieved",                               // optional
    "type": "monetary",                                         // optional, monetary | point | coupon | notification
    "isActive": true,                                           // optional
    "isDraft": false,                                           // optional
    "rewardType": "monetary",                                   // optional, monetary | point
    "pointsDividend": 1,                                        // optional
    "pointsDivisor": 1,                                         // optional
    "aliquot": 1000,
    "aliquotType": 0,                                           // optional
    "coupon": 0,                                                // optional
    "recurrentByOrder": false,                                  // optional
    "availabilityMode": "consecutiveDays",                      // optional, consecutiveDays | dateRange
    "delayTime": 86400,                                         // optional
    "expiryTime": 1296000,                                      // optional
    "expiryPeriod": "<expiryPeriod>",                           // optional, week | month | year
    "dateRangeStart": "2026-03-01T00:00:00-03:00",              // optional
    "dateRangeEnd": "2026-12-31T23:59:59-03:00",                // optional
    "initAt": "2026-03-01T00:00:00-03:00",
    "finishAt": "2026-03-31T23:59:59-03:00",
    "storeGroups": "",
    "segmentations": "[]",
    "redemptionPolicy": 0,                                      // optional
    "messageSequence": "<messageSequence>",                     // optional
    "campaignTag": 0,                                           // optional
    "rewardSegmentAdd": "<rewardSegmentAdd>",                   // optional
    "rewardSegmentDel": "<rewardSegmentDel>",                   // optional
    "list": 0,                                                  // optional
    "reactivateWithActiveCards": false,                         // optional
    "skipWithActiveCards": true,                                // optional
    "reactivationDateStart": "<reactivationDateStart>",         // optional
    "reactivationDateEnd": "<reactivationDateEnd>"              // optional
}

Respostas

Copied to clipboard