PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List community members GETGet a community member GETList messages in a channel GETPost a message as the app POSTList channels GETList courses GETGet a course outline GETList a member's course progress GETUncomplete a module for a member DELETEComplete a module for a member PUTList the app's badges GETCreate or update a badge by key POSTUpdate a badge PATCHDelete a badge DELETERevoke a badge from a member DELETEAward a badge to a member PUTSend a notification to members POST
Community

Complete a module for a member

Requires `COURSE_PROGRESS_WRITE`. Marks the module complete for the member. Safe to repeat: an already completed module keeps its original `completedAt`. Works for any module of a course members can see (published and sold through at least one product), whatever the member's plan. Emits `community.module.completed`, and `community.course.completed` when this completes the course, at most once per member and course (uncompleting and completing the last module again does not repeat it). The member must be `ACTIVE`.

PUT
/community/members/{memberId}/progress/{moduleId}

Requires COURSE_PROGRESS_WRITE. Marks the module complete for the member. Safe to repeat: an already completed module keeps its original completedAt. Works for any module of a course members can see (published and sold through at least one product), whatever the member's plan. Emits community.module.completed, and community.course.completed when this completes the course, at most once per member and course (uncompleting and completing the last module again does not repeat it). The member must be ACTIVE.

Authorization

x-api-key<token>

In: header

Path Parameters

memberId*string

Community membership id

moduleId*string

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/community/members/string/progress/string"
{  "data": {    "memberId": "string",    "moduleId": "string",    "chapterId": "string",    "courseId": "string",    "completedAt": "2019-08-24T14:15:22Z",    "videoPositionSeconds": 0  }}

Uncomplete a module for a member DELETE

Requires `COURSE_PROGRESS_WRITE`. Clears `completedAt` and keeps the video position. Safe to repeat. The member must be `ACTIVE`.

List the app's badges GET

Requires `COMMUNITY_BADGES_WRITE` and an app caller (`pwa_` secret); workspace API keys get 403. Badges this app defined in the installing workspace, oldest first.