How do I manage Custom Badge Properties?

This is a paid feature of Canvas Credentials.

With custom badge properties, you can add a property containing customized text or numbered values to your badges. This can be helpful for situations when you want to differentiate one badge from another within a particular issuer. For example, the badge properties could indicate that it was awarded for a credit-bearing course. It could also indicate how many course-credits the badge represents. Issuers can create multiple custom badge properties that can be associated with badges.

Setting up custom badge properties requires three different steps. It must be:

  1. Enabled in the organization settings.
  2. Designed in the issuer settings.
  3. Activated on the individual badges, where applicable.

Enabling custom badge properties for your organization

  1. From your Canvas Credentials account, select the Canvas Credentials logo in the upper left, and select your organization from the drop-down menu to navigate to your organization's space.
  2. Select the box with the ellipses and then select Edit organization.
  3. Select the Content settings tab.
  4. Under the title Content settings, you will see a list of items with checkboxes.
  5. Locate Allow custom badge properties and check the box.
Enabling custom badge properties for your organization

Creating custom badge properties for your issuer

  1. From the issuer tab, select the issuer where you plan to add badge properties.
  2. Select the box with the ellipses and select Edit issuer from the drop menu.
  3. Select the Custom badge properties tab in the middle of the page.
  4. Select the Add custom badge property button. This will open editing options.
Creating custom badge properties for your issuer

Property types

Each property type allows editors to enter a property name and property description and indicate if the property should be visible or not. There are four different choices available when creating badge properties. Select the option that best suits your organization's needs.

  1. Single choice — allows you to create a predefined property field with the custom choices available in a drop menu. Badge editors may associate one of the choices in the dropdown to a particular badge (e.g., Yes/No).
  2. Number — allows editors to associate a numerical value with a badge (e.g., "3").
  3. Text — allows editors to associate a string of text with a badge (e.g., "Offered in partnership with Canvas Credentials").
  4. Rich Text — allows editors to associate a string of rich text with a badge using Markdown. Markdown allows users to use formatting features such as ordered or numbered lists and URLs (e.g., [Learn more about Open Badges].
Public visibility

By default, custom badge properties are only visible to organization admins and issuers. This information also appears in CSV exports of badge data. If this box is selected, then the properties will be visible to recipients and displayed on public pages. This option is permanent once the property is saved. To change the property label, description, type or visibility, the property must be removed. If removed from the issuer, the property settings will also be removed from the associated badges and awards.

Name and description

Enter a name for your property such as "Credit bearing badges." You can optionally enter a description for your badge property.


Checking this box will make entering the property a required field on all badges associated with this issuer. Leaving this box blank will allow properties to be optional on all badges.


Adding custom properties to an existing badge

Properties can only be added to existing badges. From the issuer page, select the badge you wish to add a property to. From the badge details page, select the box with the ellipses, then Edit badge from the drop-down menu. Choose the Additional details tab, and scroll to the bottom to find the custom property options. The property will look slightly different depending on which option you selected when editing your issuer.

  • Single choice will have a dropdown menu where you can select one of your predefined property options
Adding custom properties to an existing badge
  • Number will only allow you to enter a numerical value
Adding custom properties to an existing badge
  • Rich text will allow limited formatting options
Adding custom properties to an existing badge

Select the Save changes button to add the custom property to the badge. When you view the badge's public page, the custom property will be visible if the box making the property public was selected when editing the issuer. If the box was left unselected, then the badge property will appear only for your organization's admins, but not for issuer staff or badge recipients.

Adding custom properties to an existing badge

Removing custom properties from a badge

Removing a custom property from an issuer will remove the property from any badges associated with the issuer. If you create a new custom property, you will need to add it again to any badges requiring the property. Once you've set a custom property to be Public or Private, the only way to change this status is to remove the custom property from the issuer.

  1. Select the issuer containing the property, and select the ellipses in the box to edit the issuer.
  2. Select the custom badge properties tab, and select Remove.
  3. You can select Add custom badge property if you wish to add a new custom property to your issuer.
Removing custom properties from a badge