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

Revoke a badge from a member

Requires `COMMUNITY_BADGES_WRITE` and an app caller. Safe to repeat. Removing an existing award emits `community.badge.revoked`. Works for members in any status.

DELETE
/community/members/{memberId}/badges/{badgeId}

Requires COMMUNITY_BADGES_WRITE and an app caller. Safe to repeat. Removing an existing award emits community.badge.revoked. Works for members in any status.

Authorization

x-api-key<token>

In: header

Path Parameters

memberId*string

Community membership id

badgeId*string

Response Body

application/json

application/json

application/json

curl -X DELETE "https://example.com/community/members/string/badges/string"
{  "data": {    "badgeId": "string",    "memberId": "string",    "revoked": true  }}

Delete a badge DELETE

Requires `COMMUNITY_BADGES_WRITE` and an app caller. Deletes the badge and every award of it. No `community.badge.revoked` events are sent.

Award a badge to a member PUT

Requires `COMMUNITY_BADGES_WRITE` and an app caller. Safe to repeat: an existing award keeps its `awardedAt` and sends no event. A new award emits `community.badge.awarded`. The member must be `ACTIVE`.