Skip to main content
PUT
Update CourseMember
Updates an existing CourseMember record. You must include the Id of the record to update along with all required fields.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CourseMember-Edit role.

Request Body

Required Fields

integer
required
The Id of the CourseMember record to update.
integer
required
ID of the course the member is enrolled in.
integer
required
ID of the customer enrolled in the course.

Optional Fields

boolean
Whether the member has been approved to access the course content.
boolean
Whether the member has been blocked from accessing the course.

Code Examples

Response

200

integer
HTTP status code. 200 on success.
string
A human-readable message confirming the update.
object
Contains the Id of the updated record.
boolean
true if the coursemember was updated successfully.
array
null on success.
Example Response

400

string
A summary of the validation error(s), in the format PropertyName: error message.
any
null on validation failure.
object[]
Array of validation errors.
boolean
false when the request fails validation.
Example Response