Skip to content

Applies a partial update to a section, accepting the drip fields that match the course type.

Beyond title and status, a scheduled course also accepts scheduled_at and a structured course accepts reactions_count, which stores the drip delay in days. The two are mutually exclusive: setting a schedule clears the delay and vice versa. Changing either fires its own hook so drip notifications can be rescheduled.

Endpoint

  • Method: PATCH

  • Path: /admin/courses/{course_id}/sections/{section_id}

  • Edition: Core

  • Controller: CourseAdminController@patchSection

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

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

  • Requires the course-creator permission and management access to this course.

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.

PATCH Patch Course Section

PATCH
/admin/courses/{course_id}/sections/{section_id}

Applies a partial update to a section, accepting the drip fields that match the course type.

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

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
section_id*

Section ID extracted from the URL path.

Type
integer
Required

Request Body

application/json
JSON
{
  
"status": "string"
}

Responses

Successful response

application/json
JSON
{
  
"message": "string",
  
"topic": {
  
  
"comments_count": 0,
  
  
"content_type": "string",
  
  
"created_at": "string",
  
  
"expired_at": "string",
  
  
"featured_image": "string",
  
  
"id": 0,
  
  
"is_sticky": "string",
  
  
"message": "string",
  
  
"message_rendered": "string",
  
  
"meta": {
  
  
  
"preview_data": "string"
  
  
},
  
  
"parent_id": "string",
  
  
"priority": "string",
  
  
"privacy": "string",
  
  
"reactions_count": 0,
  
  
"scheduled_at": "string",
  
  
"slug": "string",
  
  
"space_id": "string",
  
  
"status": "string",
  
  
"title": "string",
  
  
"type": "string",
  
  
"updated_at": "string",
  
  
"user_id": "string"
  
}
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation