LearnDash icon

LearnDash

Interact with the LearnDash LMS REST API

Actions60

Groups → Create

AI-generated

Summary

Create a new LearnDash group by specifying standard group fields or providing a custom JSON body to define the group's properties.

Inputs

  • Group Fields — Optional individual fields for the new group such as title, content, excerpt, status (draft, publish, etc.), slug, and parent course ID. Use to configure common properties without custom JSON.
  • Body (JSON) — A raw JSON string representing the request payload to create the group. Allows for advanced configurations beyond the common fields.

Output shape

A list containing the created group object as returned by the LearnDash API.

The output is the API response parsed into JSON, typically an array with a single group object. If both Group Fields and Body (JSON) are provided, their values are merged with Body (JSON) fields overriding. Input validation is performed on the JSON input; invalid JSON will cause an error.

Examples

Example 1: Creating a simple group with a title and status

Set 'Group Fields' with 'Title' and 'Status' (e.g., 'publish') and leave 'Body (JSON)' empty.

Example 2: Creating a group with custom advanced options

Provide a fully defined JSON payload in 'Body (JSON)' with all desired group properties.

Discussion