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.

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
Method Parameters
badgeBadgeRequired

Badge to create.

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