Developers
Users

Create a points adjustment

POST/users/{user_id}/score-adjustments

Creates a manual adjustment to the user's points. The adjustment is recorded as a point entry in the points ledger together with its author and reason, and the user's balance changes by the adjusted amount.

points must be a non-zero integer; negative values deduct points. Use product_id to associate the adjustment with a product.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

user_id*string

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/users/string/score-adjustments" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "points": 0,    "reason": "string"  }'
{  "data": {    "author": {      "id": "string",      "kind": "admin"    },    "balance_after": 0,    "created_at": "2019-08-24T14:15:22Z",    "id": "string",    "object": "score_adjustment",    "points": 0,    "product_id": "string",    "reason": "string",    "score_id": "string",    "user_id": "string"  }}

List user progress GET

Returns the user's progress in each product, using cursor-based pagination. If the current credentials are restricted to specific products, only those products are included.

List point entries GET

Returns the user's points ledger, using cursor-based pagination. If the user is not accessible with the current credentials, the API returns `404 Not Found` rather than an empty collection.