Skip to content

Set or assign sections for a course

PUT
/wp-json/wp2/course-manager/v1/courses/{course_id}/sections
curl --request PUT \
--url https://example.com/wp-json/wp2/course-manager/v1/courses/1/sections \
--header 'Content-Type: application/json' \
--header 'X-WP-Nonce: <X-WP-Nonce>' \
--data '{ "sectionIds": [ 18, 19 ], "mode": "replace" }'

Mode=replace (default): assign listed sectionIds and unassign others previously linked to this course. mode=assign: only assign listed IDs. Requires WP2LMS.

course_id
required
integer
>= 1
Media typeapplication/json
object
sectionIds
required
Array<integer>
mode
string
default: replace
Allowed values: replace assign
Example
{
"sectionIds": [
18,
19
],
"mode": "replace"
}

Resulting membership.

Media typeapplication/json
object
ok
boolean
courseId
integer
mode
string
sectionIds
Array<integer>
Examplegenerated
{
"ok": true,
"courseId": 1,
"mode": "example",
"sectionIds": [
1
]
}

Wp2cm_invalid_section_ids

Media typeapplication/json
object
code

Machine-readable error or event code.

string
message

Message text (log, PIN, or password reset).

string
data

Extra WP_Error or license payload.

object
Examplegenerated
{
"code": "example",
"message": "example",
"data": {}
}

Not authenticated.

Media typeapplication/json
object
code

Machine-readable error or event code.

string
message

Message text (log, PIN, or password reset).

string
data

Extra WP_Error or license payload.

object
Examplegenerated
{
"code": "example",
"message": "example",
"data": {}
}

Insufficient capability or invalid REST nonce.

Media typeapplication/json
object
code

Machine-readable error or event code.

string
message

Message text (log, PIN, or password reset).

string
data

Extra WP_Error or license payload.

object
Examplegenerated
{
"code": "example",
"message": "example",
"data": {}
}

Wp2cm_invalid_course_term / wp2lms_invalid_section_term

Media typeapplication/json
object
code

Machine-readable error or event code.

string
message

Message text (log, PIN, or password reset).

string
data

Extra WP_Error or license payload.

object
Examplegenerated
{
"code": "example",
"message": "example",
"data": {}
}

Wp2cm_course_link_unavailable

Media typeapplication/json
object
code

Machine-readable error or event code.

string
message

Message text (log, PIN, or password reset).

string
data

Extra WP_Error or license payload.

object
Examplegenerated
{
"code": "example",
"message": "example",
"data": {}
}