Reset Course Status

Resets a user's progress on a specified course, with options to revoke access and erase transcript data

Resets a user's progress on a specified course, with options to revoke access and erase transcript data.

POSThttps://example.thoughtindustries.com/incoming/v2/users/:id/resetProgress

Example request

curl -X POST "https://example.thoughtindustries.com/incoming/v2/users/:id/resetProgress" \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "userId": "00000000-0000-0000-0000-000000000000",
  "slug": "string",
  "resetProgress": true,
  "revokeAccess": true
}'

Parameters

Name	Type	Required	Location	Description
`id`	`string`	Yes	path	The id identifier.
`userId`	`uuid`	No	body	UUID of the user whose course progress will be reset.
`slug`	`string`	Yes	body	URL slug identifying the course to reset.
`resetProgress`	`boolean`	No	body	When `true`, clears all progress data recorded for the user on this course.
`revokeAccess`	`boolean`	Yes	body	When `true`, removes the user's access to the course after the reset.
`eraseTranscript`	`boolean`	No	body	When `true`, removes the course completion record from the user's transcript.

Example response

{
  "data": {
    "ResetUserCourseProgress": true
  }
}