A badge is a visible label displayed on a site member's profile.
Site owners can create badges to categorize members and optionally grant them special permissions to access specific pages.
Badges are managed separately from their assignment to members. To assign badges to members, use the Badge Assignments API.
For more information, see Creating and Managing Member Badges.
Badge ID.
Revision number, which increments by 1 each time the badge is updated. To prevent conflicting changes, the current revision must be passed when updating the badge.
Badge title displayed on the member's profile.
Badge description explaining its purpose or criteria for earning it.
Badge background color in hexadecimal RGB format.
Badge text color in hexadecimal RGB format.
Badge icon image.
Any image format is accepted with automatic conversion and resizing handled by the system. SVG format is recommended as it is resolution independent and looks great at any scale.
Whether the badge grants special permissions to access specific members-only pages.
When true, members with this badge receive special permissions.
Site owners can configure these permissions in the site dashboard. For more information, see Creating and Managing Member Badges.
URL-friendly slug for the badge, automatically generated from the title.
Generated by converting the title to lowercase, replacing spaces with hyphens, and removing special characters.
Date and time the badge was created.
Date and time the badge was last updated.