Update progress for a user on a content block

Updates a user’s progress (status, optional userData). userId is in the path, not the body. Scoped to your integration’s institution via Basic Auth credentials.

PATCH/content-blocks/{id}/progress/{userId}

Authorization

AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters

idstringrequired

Content block ID

userIdstringrequired

User ID

Request body

requiredapplication/json

statusstring

New progress status for the user on this block

Allowed:NOT_STARTEDIN_PROGRESSFINISHEDREVIEWED

userDataobject

Optional block-type-specific progress payload (e.g. survey answers, workbench state)

forceboolean

When true, bypasses some validation guards when updating status

default: false

Responses

200

Updated progress

dataUpdateProgressResponserequired

Show properties

blockIdstringrequired

userIdstringrequired

statusstringrequired

Allowed:NOT_STARTEDIN_PROGRESSFINISHEDREVIEWED

previousStatusstring | nullrequired

Allowed:NOT_STARTEDIN_PROGRESSFINISHEDREVIEWEDnull

updatedAtstring<date-time>required

userDataobject

metaResponseMetarequired

Show properties

requestIdstringrequired

timestampstring<date-time>required

versionstringrequired

Allowed:v4

400

Bad Request

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

401

Unauthorized

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

403

Forbidden

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

404

Not Found

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

429

Too Many Requests

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

500

Internal Server Error

typestringrequired

Allowed:error

codestringrequired

Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error

titlestringrequired

statusintegerrequired

detailstringrequired

instancestring

errorsobject[]

Show properties

Array of object

fieldstring

messagestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Basic auth usernameBasic auth password

Remember on this deviceInclude my values in samples

Parameters

idpath*Content block IDuserIdpath*User ID

Bodyapplication/json

Request body

Request

curl -X PATCH 'https://fuxam.app/api/v4/content-blocks/string/progress/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "FINISHED",
  "userData": {
    "lastViewedAt": "2026-06-23T10:15:00.000Z",
    "answers": {
      "q1": "option_a"
    }
  },
  "force": false
}'

const response = await fetch("https://fuxam.app/api/v4/content-blocks/string/progress/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Basic YOUR_CREDENTIALS",
    "Content-Type": "application/json"
  },
  body: "{\n  \"status\": \"FINISHED\",\n  \"userData\": {\n    \"lastViewedAt\": \"2026-06-23T10:15:00.000Z\",\n    \"answers\": {\n      \"q1\": \"option_a\"\n    }\n  },\n  \"force\": false\n}"
});

import requests

response = requests.patch(
    "https://fuxam.app/api/v4/content-blocks/string/progress/string",
    headers={
        "Authorization": "Basic YOUR_CREDENTIALS",
        "Content-Type": "application/json"
    },
    data="{\n  \"status\": \"FINISHED\",\n  \"userData\": {\n    \"lastViewedAt\": \"2026-06-23T10:15:00.000Z\",\n    \"answers\": {\n      \"q1\": \"option_a\"\n    }\n  },\n  \"force\": false\n}",
)

Response

{
  "data": {
    "blockId": "string",
    "userId": "string",
    "status": "NOT_STARTED",
    "previousStatus": "NOT_STARTED",
    "updatedAt": "2019-08-24T14:15:22Z",
    "userData": {}
  },
  "meta": {
    "requestId": "req_1234567890_abc",
    "timestamp": "2026-06-02T07:00:00.000Z",
    "version": "v4"
  }
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "error",
  "code": "resource_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "Course not found",
  "instance": "req_1234567890_abc",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}