Users

Updates the specified user's profile, license assignments, course access, and related attributes.

Example request

curl -X PUT "https://example.thoughtindustries.com/incoming/v2/users/:id" \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "clientId": "00000000-0000-0000-0000-000000000000",
  "studentLicenseIds": ["00000000-0000-0000-0000-000000000000"],
  "replaceLicenseAccess": true,
  "panoramaEnrollmentOptions": {
    "preserveEnrollments": false,
    "preserveProgress": true
  }
}'

Parameters

Panorama enrollment options

panoramaEnrollmentOptions only takes effect when this request actually changes the user's Panorama or license access — for example, when clientId moves the user to a different Panorama, or when license fields (such as studentLicenseIds or studentLicenseSkus) are combined with replaceLicenseAccess: true. On any other update the field is ignored.

Both options apply only to source-only enrollments: content the learner reaches through the licenses being removed and through no other license they keep or gain. Content available through both the old and the new licenses — overlap content — is never removed and never has its progress reset, whatever the two options are set to. Only its license association changes: the removed license IDs are dropped from the enrollment and the retained or newly added license that also covers it is stamped in their place. Courses the learner reaches through a learning path that survives the move are treated as overlap content for the same reason.

The object accepts two booleans, each defaulting to true. Three combinations are valid:

The fourth combination — preserveEnrollments: true with preserveProgress: false — is invalid, because progress cannot be reset while the enrollment is preserved. It is rejected without applying the update (see "Validation errors" below).

Always preserved: preserveProgress: false clears only in-course progress for the affected content — topic-level progress, the resume position, the completion percentage, and assignment submissions, quiz attempts, and SCORM attempts. Certificates are never revoked, hidden, or invalidated, and the course and learning path completion records that make up their transcript are left in place (milestone completions inside a reset learning path are cleared, because learning path progress is derived from them). Achievements and awards move with the learner to the new Panorama rather than being removed. No parameter on this endpoint resets certificates, transcripts, or achievements — panoramaEnrollmentOptions accepts only the two booleans above.

Note: Courses with Restart Progress After Re-Enrollment enabled are the one exception. That setting is off by default and is turned on per course, in the course's eCommerce settings under Access, typically for recertification. Whenever the learner loses access to such a course — any time preserveEnrollments is false, including the false / true combination — that course's saved progress, quiz attempts, and SCORM attempts are cleared and its completion entry is removed from the transcript. The certificate itself is retained, and if your company displays past completions on the transcript, the completion still appears there. This is long-standing platform behavior for any loss of access — the same reset happens when access expires or a learner is automatically unenrolled — not something specific to panoramaEnrollmentOptions.

Example response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "learnerUserId": "00000000-0000-0000-0000-000000000000",
  "managerUserId": "00000000-0000-0000-0000-000000000000",
  "clientId": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "disabled": true,
  "sfAccountId": "00000000-0000-0000-0000-000000000000",
  "sfContactId": "00000000-0000-0000-0000-000000000000",
  "roleKey": "string",
  "address1": "string",
  "address2": "string",
  "city": "string",
  "state": "string",
  "zipCode": "string",
  "telephone": "string",
  "country": "string",
  "stripeCustomerId": "00000000-0000-0000-0000-000000000000",
  "externalCustomerId": "string",
  "shippingName": "string",
  "asset": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "lastActiveAt": "2024-01-01T00:00:00.000Z",
  "ref1": "string",
  "ref2": "string",
  "ref3": "string",
  "ref4": "string",
  "ref5": "string",
  "ref6": "string",
  "ref7": "string",
  "ref8": "string",
  "ref9": "string",
  "ref10": "string",
  "language": "string",
  "customFields": {},
  "purchasedBundles": [
    {
      "bundleId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "allocatedLicenses": [
    {
      "licenseId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "allocatedLearningPaths": [
    {
      "learningPathId": "00000000-0000-0000-0000-000000000000",
      "status": "string"
    }
  ],
  "purchasedCourses": [
    {
      "courseId": "00000000-0000-0000-0000-000000000000",
      "status": "string"
    }
  ],
  "waitlistedCourses": [
    {
      "courseId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "balance": 0,
  "preferredCurrency": "string"
}

Validation errors

Supplying panoramaEnrollmentOptions with preserveEnrollments: true and preserveProgress: false is invalid — progress cannot be reset while the enrollment is preserved. The request is rejected and no changes are applied.

Unlike a successful response, which is unwrapped to the user object, this validation failure keeps the GraphQL envelope and is returned with HTTP status 200. Detect it by checking for an errors key rather than by status code:

{
  "errors": [
    { "message": "Cannot reset progress while preserving enrollment" }
  ],
  "data": {
    "APIUpdateUser": null
  }
}

Note: Entries in errors may carry additional GraphQL fields such as locations, path, and extensions. Match on errors[0].message rather than on the exact object shape.

Response fields