Skip to content
Mindtickle Developer DocsBeta

Try searching for

↑↓ to navigate↵ to openesc to close
Dark mode

Complete a module for a user

Marks progress as complete for a single user in a module, with an optional backdated completion timestamp.

View as Markdown(opens in a new tab)
Use with AI

Open this page in

ChatGPT(opens in a new tab)Claude(opens in a new tab)Cursor(opens in a new tab)

Prerequisites

  1. Authentication and setup: A valid access token.
  2. Invite users to a module: The user must be invited to the module and belong to the series.
  3. Search users: Get the Mindtickle user ID for the user.

Endpoint

Section titled “Endpoint”
POST /services/data/v4.0/mtobjects/Series/SID/Module/MODULE_ID/User/USER_ID/complete_progress

Replace SID, MODULE_ID, and USER_ID with the Mindtickle IDs of the series, the module, and the user.

Base URL: the standard REST host for your region. See Base URLs.

Headers: Authorization: Bearer ACCESS_TOKEN, Content-Type: application/json.

Path parameters

Section titled “Path parameters”
Parameter Type Required Description
SID string Required Mindtickle ID for the series.
MODULE_ID string Required Mindtickle ID for the module.
USER_ID string Required Mindtickle ID for the user.

Request

Section titled “Request”
Parameter Type Required Description
completed_on timestamp Optional Epoch timestamp, in seconds, indicating when the user should be marked as completed.

Request example

Section titled “Request example”
{
  "completed_on": 1747226602
}

Response

Section titled “Response”
Field Type Description
requestId string Unique ID for tracking the request.
completionStatus boolean Indicates whether the user’s progress was successfully marked as complete.

Response example

Section titled “Response example”
{
  "requestId": "req_101",
  "completionStatus": true
}

Errors

Section titled “Errors”
Status Error Reason
400 Bad Request Invalid User Id The format or value of user ID is incorrect.
400 Bad Request User not part of the module! User is not eligible for the specified module.
400 Bad Request User not part of the module for the series! User is not linked to both module and series.
400 Bad Request Completion date cannot be smaller than invitation date! Logical validation failure.
400 Bad Request Invalid request body Malformed or missing request payload.
400 Bad Request Invalid date in epoch timestamp! Date format or logic is invalid.
400 Bad Request Future completion time not allowed! Completion timestamp must not be in the future.
429 Too Many Requests Too Many Requests Rate limit is exceeded, retry after the seconds given in the Retry-After header.
404 Not Found Invalid Module ID! Provided module ID does not exist.
500 Internal Server Error Failed to complete progress for users General server-side failure completing progress.
500 Internal Server Error Unable to complete progress for users Processing issue during update.
500 Internal Server Error Unknown exception while completing progress!! Catch-all for unhandled runtime exceptions.
500 Internal Server Error Unable to check user invitation! Unexpected failure when validating invitation.

Notes

Section titled “Notes”
  • Defaults: If completed_on is omitted or left blank, the current date and time is used by default.
  • User IDs: Use the Search users API to get the Mindtickle user ID for a user.
  • Backdated invitations: When migrating users or recording past progress, invite dates must align with completion dates. Completion APIs accept backdated completions as long as the learner’s invitation date is also backdated appropriately. See Backdated series invitations and Backdated module invitations.
  • Supported module types: Course, quick update, and assessment.
  • Limitations: The module must be published and must be part of the specified series, and the user must belong to the series.
  • Scoring: This API marks the user as 100% complete with a 100% score for the selected module. Partial or granular completion and scores cannot be recorded, and future-dated completions are not allowed.