Sign in

Add points

POST https://{organization}.myguper.com/api/register/person/{personId}/tier/points

Adds a tier-points entry to a person. Tier balance and level are recalculated immediately. Use source: rewardCampaign (with the sourceId of the underlying transaction) when the points come from a loyalty event, or source: manual for ops-driven adjustments.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Path parameters

Name Type Description
personId * integer Internal Guper person ID.

Request body

Content-Type: application/json

{
    "source": "rewardCampaign",
    "sourceId": "tx_demo_a1b2c3d4",                             // optional
    "value": 150,                                               // points
    "expireAt": "2027-05-01T00:00:00-03:00",                    // optional
    "description": "Cashback ord_2026_001"                      // optional
}

Responses

{
    "success":      true,
    "pointsAdded":  150,
    "source":       "rewardCampaign",
    "activePoints": 2350
}
Copied to clipboard