Developers
Users38

Create a progress adjustment

POST/users/{user_id}/products/{product_id}/progress/adjustments

Creates a progress adjustment for the user in a product. A reset adjustment clears the user's progress in the product. The reason is stored with the adjustment.

Points and certificates already earned are not reverted by a reset.

A reset requires the user to have started the product. When the user has never opened it, there is no progress to reset and the request fails with 409 progress_not_started (details[].reason is not_started).

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

Public ID of the user, prefixed with usr_.

product_id*string

Public ID of the product, prefixed with prd_.

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

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/users/string/products/string/progress/adjustments" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "reason": "string",    "type": "reset"  }'
{  "data": {    "author": {      "id": "string",      "kind": "admin"    },    "created_at": "2019-08-24T14:15:22Z",    "id": "string",    "object": "progress_adjustment",    "product_id": "string",    "reason": "string",    "result": {      "history_removed": 0,      "lessons_cleared": 0    },    "type": "reset",    "user_id": "string"  }}

List progress adjustments GET

Returns the progress adjustments recorded for the user in a product, using cursor-based pagination. Each adjustment identifies its author as either an administrator (`admin`) or an API credential (`credential`).

Retrieve a progress adjustment GET

Retrieves a progress adjustment recorded for the user in a product.