Replaces the sidebar link list shown on a course with the submitted set.

Each link is sanitised individually. The submitted array replaces the stored one wholesale.

Endpoint

• Method: POST

• Path: /admin/courses/{course_id}/links

• Edition: Core

• Controller: CourseAdminController@updateLinks

• Route source: fluent-community/Modules/Course/Http/course_api.php:37

• Controller source: fluent-community/Modules/Course/Http/Controllers/CourseAdminController.php

• Requires a course admin for this course, or a WordPress user with manage_options.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

POST Update Course Links

POST

/admin/courses/{course_id}/links

Replaces the sidebar link list shown on a course with the submitted set.

Controller: CourseAdminController@updateLinks
Route source: fluent-community/Modules/Course/Http/course_api.php:37

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type

API Key (header: Authorization)

Parameters

Path Parameters

course_id*

Course ID extracted from the URL path.

Type

integer

Required

Request Body

application/json

{

  

"links": [

  

  

"string"

  

]

}

Responses

Successful response

Content-Type

application/json

{

  

"links": [

  

  

{

  

  

  

"slug": "string",

  

  

  

"title": "string"

  

  

}

  

],

  

"message": "string"

}

POST

/admin/courses/{course_id}/links

Playground

Authorization

ApplicationPasswords

Variables

Key

Value

course_id*

Body

Samples

Powered by VitePress OpenAPI