> ## Documentation Index > Fetch the complete documentation index at: https://docs.msportal.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update enrollment > Update enrollment progress, status, or score. ## OpenAPI ````yaml /openapi.json patch /api/public/v1/training/enrollments/{id} openapi: 3.0.3 info: title: MSPortal Public API version: 1.0.0 description: >- Public API for MSPortal - provides programmatic access to tenant data. ## Authentication All endpoints require authentication via API key passed as a Bearer token: ``` Authorization: Bearer ``` API keys can be created in the MSPortal dashboard under Settings → Integrations → API Access. **Important:** Do not include cookies in API requests. The public API uses stateless authentication only. ## Scopes API keys are granted specific scopes that determine what operations they can perform. Each endpoint documents its required scope(s). ## Rate Limiting API calls are rate limited per API key. Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests per minute - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: When the rate limit resets (ISO 8601) ## Request ID All responses include an `X-Request-Id` header for debugging and support. You can also pass your own `X-Request-Id` header to correlate requests. contact: name: MSPortal Support email: support@msportal.ai license: name: Proprietary servers: - url: https://app.msportal.ai description: Production environment security: - BearerAuth: [] tags: - name: Budgets description: >- Budget management - create, track, and forecast budgets with line items, categories, and products - name: Calendar description: Calendar and meeting management - events, participants, and meeting types - name: Companies description: Company management endpoints - name: Company Users description: Company user management - client portal contacts (read-only, paginated) - name: Compliance description: Compliance check management - runs, assigned checks, and status updates - name: Dashboards description: Dashboard management - external iframe resources and internal dashboards - name: Devices description: Device management - inventory, types, and locations - name: Goals description: Goal management - create, track, and manage goals with tasks and updates - name: NPS Surveys description: >- NPS survey management - Net Promoter Score surveys, responses, and analytics - name: Reports description: >- Report management - create, manage, and schedule reports with templates and types - name: Planner description: >- Planner item management - tasks, roadmap items, and project planning with linked goals, compliance, and projects - name: Surveys description: >- General survey management - multi-question surveys, responses, and statistics - name: Tickets description: Ticket management - view and filter tickets from PSA integrations - name: Training description: >- Training management - courses, enrollments, certificates, and progress tracking - name: Users description: Tenant user management - internal staff and team members (read-only) - name: Automation Rules description: >- Automation rule management - create, configure, and monitor automation rules with triggers, conditions, and actions - name: Analytics description: >- Analytics and reporting - company audit data, training analytics, user activity, and portfolio metrics paths: /api/public/v1/training/enrollments/{id}: patch: tags: - Training summary: Update enrollment description: Update enrollment progress, status, or score. parameters: - schema: type: string format: uuid description: Enrollment ID required: true description: Enrollment ID name: id in: path requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateTrainingEnrollmentRequest' responses: '200': description: Enrollment updated content: application/json: schema: $ref: '#/components/schemas/TrainingEnrollmentSingleResponse' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Enrollment not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: UpdateTrainingEnrollmentRequest: type: object properties: status: type: string enum: - not_started - in_progress - completed description: Enrollment status progress: type: number minimum: 0 maximum: 100 description: Progress percentage score: type: number minimum: 0 maximum: 100 description: Score achieved dueDate: type: string nullable: true format: date-time description: Due date (null to clear) TrainingEnrollmentSingleResponse: type: object properties: data: $ref: '#/components/schemas/TrainingEnrollment' required: - data ErrorResponse: type: object properties: error: type: string description: Error message requestId: type: string description: Request correlation ID details: nullable: true description: Additional error details code: type: string description: Error code required: - error TrainingEnrollment: type: object properties: id: type: string format: uuid description: Enrollment ID course: $ref: '#/components/schemas/TrainingEnrollmentCourseRef' user: $ref: '#/components/schemas/TrainingEnrollmentUserRef' status: type: string enum: - not_started - in_progress - completed description: Enrollment status progress: type: number minimum: 0 maximum: 100 description: Progress percentage (0-100) score: type: number nullable: true description: Score achieved enrolledAt: type: string format: date-time description: Enrollment timestamp (ISO 8601) startedAt: type: string nullable: true format: date-time description: When user started the course completedAt: type: string nullable: true format: date-time description: Completion timestamp dueDate: type: string nullable: true format: date-time description: Due date for completion timeSpentSeconds: type: number description: Total time spent in seconds certificateId: type: string nullable: true format: uuid description: Certificate ID if completed companyId: type: string nullable: true format: uuid description: Company context required: - id - course - user - status - progress - score - enrolledAt - startedAt - completedAt - dueDate - timeSpentSeconds - certificateId - companyId TrainingEnrollmentCourseRef: type: object properties: id: type: string format: uuid description: Course ID title: type: string description: Course title courseType: type: string description: Course type required: - id - title - courseType TrainingEnrollmentUserRef: type: object properties: id: type: string format: uuid description: User ID fullName: type: string description: User's full name email: type: string description: User's email required: - id - fullName - email securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access. ````