Entrar

External Event: Criar reward

POST https://{organization}.myguper.com/api/loyalty/external-event

Emite reward cards orientados por campanhas do tipo external-events — usado quando um sistema externo (CRM, app, e-mail) decide quando e quanto recompensar, e a Guper apenas cria os cards seguindo a identidade da campanha (validade, tags, sequence, mensageria).

A campanha fornece a estrutura; o body fornece o valor. Internamente o aliquot da campanha é sobrescrito pelo value enviado, então cada entrada em campaigns[] produz exatamente um reward card do valor pedido. startsAt / expiresAt opcionais por entrada sobrescrevem a janela de validade default do card resultante.

Aceita um objeto único { id, value } ou um array de objetos — objeto único é wrappeado automaticamente.

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

{
    "interface": "generic",
    "client": {
        "id": "123123",                                         // optional
        "countryCallingCode": 55,                               // optional
        "cellphone": "19954264546",                             // optional
        "email": "tintim@guper.co",                             // optional
        "document": "<document>",                               // optional
        "name": "Tintim"                                        // optional
    },
    "campaigns": [
        {
            "id": 7,
            "value": 5000,                                      // cents
            "startsAt": "2026-05-08",                           // optional
            "expiresAt": "2027-05-08"                           // optional
        }
    ],
    "storeId": "<storeId>"                                      // optional
}

Respostas

{
    "reward": [
        { "TID": "54eb6281…", "campaign": 7,  "rewardValue": 5000 },
        { "TID": "54eb6281…", "campaign": 12, "rewardValue": 1000 }
    ],
    "total": 6000
}

Relacionados

Copied to clipboard