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

Delete a badge

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

DELETE
/community/badges/{badgeId}

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

Authorization

x-api-key<token>

In: header

Path Parameters

badgeId*string

Response Body

application/json

application/json

application/json

curl -X DELETE "https://example.com/community/badges/string"
{  "data": {    "id": "string",    "deleted": true  }}

Update a badge PATCH

Requires `COMMUNITY_BADGES_WRITE` and an app caller. Only the app's own badges; others are 404. `key` can't change.

Revoke a badge from a member DELETE

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.