Create Course

POST

api

content

courses

Create Course

curl --request POST \
  --url https://spaces.nexudus.com/api/content/courses \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "HostId": 123,
  "Title": "<string>",
  "DisplayOrder": 123,
  "Visibility": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "HostId": 123,
    "Title": "<string>",
    "DisplayOrder": 123,
    "Visibility": 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({
    BusinessId: 123,
    HostId: 123,
    Title: '<string>',
    DisplayOrder: 123,
    Visibility: 123
  })
};

fetch('https://spaces.nexudus.com/api/content/courses', 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 Course is a structured learning module published to customers through the Members Portal. Courses are organised into sections (milestones) and lessons (individual content units). They can be used for internal training, community building, or self-learning offers. Courses belong to a Location and are assigned a Host (a customer or administrator) who is responsible for its content. You can control who can access a course using the Visibility field:

Visibility	Meaning
Public	Visible and accessible to everyone on the Members Portal
Hidden	Not listed on the Members Portal but accessible via a direct link
Private	Only accessible to members who have been explicitly added
Paid	Requires purchase via the linked `TariffId` pricing plan

Courses can optionally display a community discussion group (HasCommunityGroup), be featured on the portal home page (ShowInHomePage), and be grouped together under a GroupName for easier navigation.

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

Enums

eCourseVisibility — Visibility values

Value	Name
1	Public
2	Hidden
3	Private
4	Paid

Request Body

Required Fields

integer

required

ID of the Location this course belongs to.

integer

required

ID of the coworker or administrator who hosts this course.

string

required

Course title displayed on the Members Portal.

integer

required

Position of the course in listing pages; lower numbers appear first.

integer

required

Access control for the course: Public (1), Hidden from listing but accessible via link (2), Private/invite-only (3), or Paid via TariffId (4).

Optional Fields

string

Short summary displayed under the course title on the Members Portal (up to ~400 characters).

string

Full course description shown in the ‘What’s this course about?’ section when customers open the course.

boolean

Whether to display the overview section on the course page.

boolean

Whether the course has an associated community discussion group on the Members Portal.

string

Overview text displayed below the full description on the course page.

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.

string

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

boolean

Set to true to remove the existing banner/large image.

boolean

Whether the course is active and available to customers.

string

Optional group label used to cluster related courses together on the Members Portal.

boolean

Whether the course is featured on the Members Portal home page.

integer

ID of the pricing plan (tariff) required to access this course when Visibility is Paid.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/content/courses" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "HostId": 0,
    "Title": "",
    "DisplayOrder": 0,
    "Visibility": 0
}'

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

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/content/courses',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'HostId': 0,
        'Title': '',
        'DisplayOrder': 0,
        'Visibility': 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 course was created successfully.

array

null on success.

Example Response

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

Update CourseUpdate an existing Course record.

Create Course

curl --request POST \
  --url https://spaces.nexudus.com/api/content/courses \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "HostId": 123,
  "Title": "<string>",
  "DisplayOrder": 123,
  "Visibility": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "HostId": 123,
    "Title": "<string>",
    "DisplayOrder": 123,
    "Visibility": 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({
    BusinessId: 123,
    HostId: 123,
    Title: '<string>',
    DisplayOrder: 123,
    Visibility: 123
  })
};

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