unassignBadge( )

Removes site members from an assigned badge.

The unassignBadge() function returns a Promise that resolves when the specified members are removed as holders of the specified badge.

The badgeId parameter must be an ID from your site's Members/Badges collection. Typically, you retrieve the ID from the collection using a query or through a dataset.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Badges
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
_idstringRequired

Badge ID.

memberIdsArray<string>Required

List of members to remove.

Was this helpful?
Yes
No