Create Badge

Creates a new badge. This is metadata describing a Badge provided on a digital credentialing platform. A provider_id can be specified for internal and Open University badges. That provider will have access to edit and issue the badge. More providers can be added later by platform admins.

available_to_all (bool) : Defaults to True.
availability (str): Optional field. If not None, available_to_all is automatically set to False.
type (Badge_Type): Mandatory field.
recipient_type (Recipient_Type): Optional field. Defaults to User.
source (Source_Type): Optional field. Defaults to Internal. Other options are Credly and Open_University. If External, external_id and external_url are mandatory.
external_id (str): Optional field. The unique ID on the external platform. If the badge already exists on Navigatr, it will be updated. If not, it will be created. External ID is required for all external badges.
external_url (str): Optional field. URL of the badge on the external platform. External URL is required for all external badges.
earn_url (str): Optional field. URL to earn the badge. Defaults to None.
information_url (str): Optional field. A link to display additional information about this badge. Defaults to None.
cost (Badge_Cost): Optional field. Defaults to Free
level (Badge_Level): Optional field. Defaults to Foundational
time_to_earn (Time_To_Earn): Optional field. Defaults to Hours
participation_type (Participation_Type): Optional field. Defaults to In_Person
end_date (datetime): Optional field. Defaults to None
time_created (datetime): Optional field. Defaults to the current time. For external badges, set the time created to match with the external platform.
tags (List[Tag]): Optional field. Defaults to None.
criteria (List[Criteria]): Optional field. Defaults to None.
alignments (List[Alignment]): Optional field. Defaults to None.
endorsements (List[Endorsement]): Optional field. Defaults to None.

generate_image (bool): Query param, defaults to False. If True, renders and uploads the Navigatr Badge Framework image immediately after creation, using provider_id's default branding. Requires design_standard=Navigatr, source=Internal (the default), no explicit image_url/image_url_2x/image_url_original, and no design_parameters.subtitle override in the body - any mismatch 422s up front, before any write. A failure in the render itself (e.g. the provider's logo URL is unreachable) does not fail badge creation - the badge is still created without an image.

Badge_Type:

Generic Types:

    Experience, Learning, Validation, Certification, Attendance, Work_Experience, Volunteering, Job,
    Apprenticeship, Course, Membership, Internship, Workshop, Campaigning, Activism, Other

Navigatr Standard Types:

    Informal_Learning, Training, Certified, Qualification

Source_Type:

Internal, Credly, Open_University

Recipient_Type:

User, Organisation

Badge_Cost:

Free, Paid, Other

Badge_Level:

Generic Levels:

    Foundational, Intermediate, Advanced, Other

Navigatr Standard Levels:

    Explore, Deepen, Apply, Teach, Lead

Time_To_Earn:

Hours, Days, Weeks, Months, Years, Other

Participation_Type:

In_Person, Hybrid, Online