LearnDash icon

LearnDash

Interact with the LearnDash LMS REST API

Actions60

Groups → Update

AI-generated

Summary

Update an existing LearnDash group by specifying its numeric ID and providing updated group details such as title, content, excerpt, status, slug, and associated course ID.

Inputs

  • Item ID (required) — Numeric ID of the LearnDash group to update.
  • Group Fields — Collection of group properties to update: title, content, excerpt, status (draft, pending, private, publish, trash), slug, and parent course ID.
  • Body (JSON) — Raw JSON payload to include in the request body for advanced or additional updates beyond common fields.

Output shape

a single updated group object in JSON format

The operation returns the updated group details as JSON. If multiple items are processed in a workflow, multiple updated group objects are returned as an array.

Examples

Example 1: Update a group's title and status

Set Item ID to the group's numeric ID and specify new title and status in Group Fields.

Example 2: Perform an advanced update using custom JSON

Set Item ID and provide a custom JSON body in Body (JSON) to override or add fields not exposed in the UI.

Discussion