createBadge( )

Deprecation Warning

This method will be deprecated on April 18, 2026.
Replace with createBadge.

Creates a badge.

New badges do not have any badge permissions by default. Wix users 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 method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Badges
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
badgeBadgeRequired

Badge to create.

Returns
Return Type:Promise<Badge>
Errors

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

Did this help?