Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Courses::Enrollment

Update Enrollment

Update an enrollment

put/courses/enrollments/{id}

Path parameters

idstring required

Request body

Example request

{
  "courses_enrollment": {
    "courses_enrollment": {
      "suspended": false,
      "suspension_reason": "Call in to reapply after robot incident"
    }
  }
}

Response

OK

idinteger

Enrollment ID

public_idstring nullable

Enrollment public ID

contact_idinteger

Contact ID

course_idinteger

Course

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

suspendedboolean nullable

Suspended

suspension_reasonstring nullable

Suspension Reason

current_pathstring nullable

Current Path

origination_source_typestring nullable

Origination Source Type

origination_source_idinteger

Origination Source ID

Example response

{
  "id": 1,
  "public_id": "kvqOCw",
  "contact_id": 3,
  "course_id": 2,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "suspended": false,
  "suspension_reason": "Call in to reapply after robot incident",
  "current_path": "/enrollments/17cadca5ec21c9c4aede396f1e2104138b4897e43a1a974026bd0fb407556d2c65",
  "origination_source_type": "Membership",
  "origination_source_id": 3,
  "contact": {
    "$ref": "#/components/schemas/ContactShortAttributes/example"
  }
}