Update CourseLesson

PUT

api

content

courselessons

Update CourseLesson

curl --request PUT \
  --url https://spaces.nexudus.com/api/content/courselessons \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CourseId": 123,
  "Title": "<string>",
  "DisplayOrder": 123,
  "UnlockType": 123,
  "UnlockAfterDays": 123,
  "CompletionType": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "CourseId": 123,
    "Title": "<string>",
    "DisplayOrder": 123,
    "UnlockType": 123,
    "UnlockAfterDays": 123,
    "CompletionType": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    CourseId: 123,
    Title: '<string>',
    DisplayOrder: 123,
    UnlockType: 123,
    UnlockAfterDays: 123,
    CompletionType: 123
  })
};

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

Updates an existing CourseLesson 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 CourseLesson-Edit role.

Enums

eLessonUnlockType — UnlockType values

Value	Name
1	Immediate
2	Sequential
3	Timed

eLessonCompletionType — CompletionType values

Value	Name
1	None
2	Visited
3	Button
4	Video

Request Body

Required Fields

integer

required

The Id of the CourseLesson record to update.

integer

required

ID of the course this lesson belongs to.

string

required

Lesson title displayed to members.

integer

required

Position of the lesson within its section (or the course if unsectioned); lower numbers appear first.

integer

required

When the lesson becomes available: Immediate (1), after the previous lesson is done — Sequential (2), or after a set number of days — Timed (3).

integer

required

Number of days after enrolment before the lesson unlocks; only used when UnlockType is Timed (3).

integer

required

How completion is tracked: None (1), Visited (2), completion Button (3), or Video watched (4). Video completion requires the lesson to embed a YouTube-hosted video..

Optional Fields

integer

ID of the course section this lesson belongs to (optional; lessons without a section appear ungrouped).

integer

ID of the coworker attributed as instructor for this lesson (optional; overrides the course-level host for this lesson).

string

Short summary shown in the lesson listing.

string

Full HTML or rich-text body of the lesson displayed to members when they open it.

boolean

Whether the lesson is active and visible to enrolled members.

string

URL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).

boolean

Set to true to remove the existing thumbnail image.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/content/courselessons" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CourseId": 0,
    "Title": "",
    "DisplayOrder": 0,
    "UnlockType": 0,
    "UnlockAfterDays": 0,
    "CompletionType": 0,
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/content/courselessons',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CourseId: 0,
      Title: '',
      DisplayOrder: 0,
      UnlockType: 0,
      UnlockAfterDays: 0,
      CompletionType: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/content/courselessons',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CourseId': 0,
        'Title': '',
        'DisplayOrder': 0,
        'UnlockType': 0,
        'UnlockAfterDays': 0,
        'CompletionType': 0,
        'Id': 87654321
    }
)

data = response.json()

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 courselesson was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CourseLesson was successfully updated.",
  "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": "Title: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Title"
    }
  ],
  "WasSuccessful": false
}

Delete CourseLessonDelete an existing CourseLesson record by its Id.

Update CourseLesson

curl --request PUT \
  --url https://spaces.nexudus.com/api/content/courselessons \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CourseId": 123,
  "Title": "<string>",
  "DisplayOrder": 123,
  "UnlockType": 123,
  "UnlockAfterDays": 123,
  "CompletionType": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "CourseId": 123,
    "Title": "<string>",
    "DisplayOrder": 123,
    "UnlockType": 123,
    "UnlockAfterDays": 123,
    "CompletionType": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    CourseId: 123,
    Title: '<string>',
    DisplayOrder: 123,
    UnlockType: 123,
    UnlockAfterDays: 123,
    CompletionType: 123
  })
};

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

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400