Create CourseMember

POST

api

content

coursemembers

Create CourseMember

curl --request POST \
  --url https://spaces.nexudus.com/api/content/coursemembers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CourseId": 123,
  "CoworkerId": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/content/coursemembers"

payload = {
    "CourseId": 123,
    "CoworkerId": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CourseId: 123, CoworkerId: 123})
};

fetch('https://spaces.nexudus.com/api/content/coursemembers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A CourseMember represents a customer’s enrolment in a Course. When a customer signs up to a course through the Members Portal they are automatically added as a CourseMember. Members can also be added manually via the Admin Panel or the API. Each CourseMember record tracks the member’s progress (LastCompletedLessonId, LastAccess) and their access status:

Approved — the member has been approved to access the course content. For public courses this is set automatically on sign-up; for private or paid courses an administrator may need to approve the enrolment.
Blocked — the member has been blocked from accessing the course.

Use CourseCompletedLesson records to query which individual lessons a member has completed.

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-Create role.

Request Body

Required Fields

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

curl -X POST \
  "https://spaces.nexudus.com/api/content/coursemembers" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CourseId": 0,
    "CoworkerId": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/content/coursemembers',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CourseId: 0,
      CoworkerId: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/content/coursemembers',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CourseId': 0,
        'CoworkerId': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the coursemember was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CourseMember was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

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.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Update CourseMemberUpdate an existing CourseMember record.

Create CourseMember

curl --request POST \
  --url https://spaces.nexudus.com/api/content/coursemembers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CourseId": 123,
  "CoworkerId": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/content/coursemembers"

payload = {
    "CourseId": 123,
    "CoworkerId": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CourseId: 123, CoworkerId: 123})
};

fetch('https://spaces.nexudus.com/api/content/coursemembers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400