Create CourseCompletedLesson

POST

api

content

coursecompletedlessons

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

import requests

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

payload = {
    "CourseLessonId": 123,
    "CourseMemberId": 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({CourseLessonId: 123, CourseMemberId: 123})
};

fetch('https://spaces.nexudus.com/api/content/coursecompletedlessons', 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 CourseCompletedLesson records that a specific CourseMember has completed a specific CourseLesson. Each record is the junction between a lesson and the enrolled member who finished it. These records are typically created automatically by the Members Portal when a member meets the lesson’s completion criteria (e.g. visiting the lesson page, clicking a completion button, or finishing a video). They can also be created or deleted manually via the API to manage progress programmatically. Use this entity to query which lessons a member has completed, or to find all members who have completed a given lesson.

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

Request Body

Required Fields

integer

required

ID of the course lesson that was completed.

integer

required

ID of the course enrolment (CourseMember) record for the member who completed the lesson.

Code Examples

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

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/content/coursecompletedlessons',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CourseLessonId': 0,
        'CourseMemberId': 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 coursecompletedlesson was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CourseCompletedLesson 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 CourseCompletedLessonUpdate an existing CourseCompletedLesson record.

Create CourseCompletedLesson

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

import requests

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

payload = {
    "CourseLessonId": 123,
    "CourseMemberId": 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({CourseLessonId: 123, CourseMemberId: 123})
};

fetch('https://spaces.nexudus.com/api/content/coursecompletedlessons', 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

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Code Examples

Response

200

400