Badge Object


A badge is an object that can be assigned to site members. Badges encourage member participation, helping members stand out. Badges can also grant access to restricted pages reserved for specific members.

Properties
idstringRead-onlyformat GUID

Badge ID.


titlestring

Text displayed on the badge.


descriptionstring

Badge description.


backgroundColorstringformat COLOR_HEX

Badge background color in hexadecimal RGB format.

Uppercase letters only.
Example: #FFFFFF.


textColorstringformat COLOR_HEX

Badge text color in hexadecimal RGB format.

Uppercase letters only.
Example: #C81B53.


iconstring

URL of the badge icon image.

It is recommended to use an SVG image format as it's resolution independent and looks good at any scale.


permissionsEnabledboolean

Whether the badge has special permissions to access specific members-only pages.

When true, members with the badge receive special permissions, and Wix users can manage badge permissions in the dashboard. When false, members with the badge receive no special permissions.


slugstringRead-only

Slugified name. Used to represent the badge in a URL.


createdDatestringRead-onlyformat date-time

Date the badge was created.


updatedDatestringRead-onlyformat date-time

Date the badge was updated.

Did this help?