assignBadge( )


Assigns a badge to site members.

The assignBadge() function returns a Promise that resolves when the specified badge is assigned to the specified members.

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.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Badges
Learn more about app permissions.
Method Declaration
Copy
function assignBadge(
  _id: string,
  memberIds: Array<string>,
): Promise<AssignBadgeResponse>;
Method Parameters
_idstringRequired

Badge ID.


memberIdsArray<string>Required

List of member IDs to assign to the badge.

Returns
Return Type:Promise<AssignBadgeResponse>
JavaScript
import { badges } from "wix-members.v2"; /* Sample id value: 'd5786246-271d-40d1-bbe5-346244e89799' * * Sample memberIds value: * [ * '7d368843-6f0c-4037-8d0e-b7e36a8a0c32' * ] */ export async function myAssignBadgeFunction(_id, memberIds) { try { const membersIdsWithBadge = await badges.assignBadge(_id, memberIds); console.log("MemberIds with assigned badge: ", membersIdsWithBadge); return membersIdsWithBadge; } catch (error) { console.error(error); // Handle the error } } /* Promise resolves to: * { * "memberIds": [ * "7d368843-6f0c-4037-8d0e-b7e36a8a0c32" * ] * } */
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?