Herald
OpenapiPoints

Grant points to a user (admin)

POST
/api/points/{realmId}/grant

Path Parameters

realmId*string

Realm ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*integer
Formatint64
bucketId?|

Target Credit Bucket. REQUIRED — every grant must name an explicit bucket; missing → 400 grant_bucket_required.

reason*string
userId*string
validityDays?|
Formatint64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/points/string/grant" \  -H "Content-Type: application/json" \  -d '{    "amount": 0,    "reason": "string",    "userId": "string"  }'
{  "amount": 0,  "bucketId": "1980377d-7926-47e0-9e64-a9d0c746404d",  "expiresAt": "string",  "grantedBalance": 0,  "totalBalance": 0,  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",  "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}