Introduction

Note:
There is a new version of this API. If you're already using this module in your code, it will continue to work.

To use the Badges API, import {badges} from the wix-members-backend module:

Copy
Did this help?

assignMembers( )

Assigns a badge to site members.

The assignMembers() 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.

Method Declaration
Copy
Method Parameters
badgeIdstringRequired

ID of the badge to assign the members to.

memberIdsArray<string>Required

IDs of the members to assign to the badge.

Returns
Return Type:Promise<Array<string>>
JavaScript
Did this help?

createBadge( )

Creates a badge.

The createBadge() function returns a Promise that resolves to the newly created badge.

New badges do not have any badge permissions by default. You can set badge permissions from the Badges page in the Dashboard.

If backgroundColor or textColor are not specified, they default to "#796EFF" (purple) and "#FFFFFF" (white) respectively.

Method Declaration
Copy
Method Parameters
badgeInfoBadgeInfoRequired

Settings for the new badge.

Returns
Return Type:Promise<Badge>
JavaScript
Did this help?

deleteBadge( )

Deletes a badge.

The deleteBadge() function returns a Promise that resolves when the specified badge is deleted.

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.

Method Declaration
Copy
Method Parameters
badgeIdstringRequired

ID of the badge to delete.

Delete a badge
JavaScript
Did this help?

listMemberBadges( )

Lists the badges assigned to each of the specified site members.

The listMemberBadges() function returns a Promise that resolves to a list of badge IDs associated with each of the specified members.

Method Declaration
Copy
Method Parameters
memberIdsArray<string>Required

List of member IDs to list badges for.

Returns
Return Type:Promise<Array<MemberBadges>>
List badges assigned to members
JavaScript
Did this help?

listMembers( )

Lists the IDs of all members assigned to a badge.

The listMembers() function returns a Promise that resolves to a list of member IDs assigned to the specified badge.

Method Declaration
Copy
function listMembers(badgeId: string): Promise<Array<string>>;
Method Parameters
badgeIdstringRequired

ID of the badge to list members of.

Returns
Return Type:Promise<Array<string>>
List members assigned to a badge
JavaScript
import { Permissions, webMethod } from "wix-web-module";
import { badges } from "wix-members-backend";

export const myListMembersFunction = webMethod(Permissions.Anyone, () => {
  const badgeId = "571495e9-98af-4ec9-b854-16c0293c9312";

  return badges
    .listMembers(badgeId)
    .then((memberIds) => {
      const firstMember = memberIds[0];
      return memberIds;
    })
    .catch((error) => {
      console.error(error);
    });
});

/*
 * Promise resolves to:
 * [
 *   "28d35f86-6694-4455-9dff-aff5d450b482",
 *   "72751428-2743-4bda-acf5-4218a4279cd3",
 *   "8831eed6-928e-4f85-b80a-e1e48fb7c4fd"
 * ]
 */
Did this help?