Sign in

v1

latestOpenAPI 3.1.02026-08-0653126213.6 KB
Badge

Update Badge

Update a badge. Partial updates are supported by only sending the keys with values that changed. 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): See below for available types.
source (Source_Type): Defaults to Internal
cost (Badge_Cost): Defaults to Free
level (Badge_Level): Defaults to Foundational
time_to_earn (Time_To_Earn): Defaults to Hours
participation_type (Participation_Type): Defaults to In_Person

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, Membership

Source_Type:

Internal, Credly

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
put/v1/badge/{badge_id}

Path parameters

badge_idinteger required

Headers

X-Access-Tokenstring nullable

Request body

namestring nullable
design_standard'Generic' | 'Navigatr'
type'Experience' | 'Learning' | 'Validation' | 'Certification' | 'Attendance' | 'Work_Experience' | 'Volunteering' | 'Job' | 'Apprenticeship' | 'Course' | 'Internship' | 'Workshop' | 'Campaigning' | 'Activism' | 'Other' | 'Informal_Learning' | 'Training' | 'Certified' | 'Qualification' | 'Membership'
language'Arabic_Modern_Standard' | 'Bengali' | 'Bulgarian' | 'Chinese_Cantonese' | 'Chinese_Mandarin' | 'Chinese_Simplified' | 'Chinese_Traditional' | 'Croatian' | 'Czech' | 'Dutch' | 'English' | 'French' | 'German' | 'Greek' | 'Hungarian' | 'Irish_Gaeilge' | 'Italian' | 'Kurdish_Kurmanji' | 'Kurdish_Sorani' | 'Latvian' | 'Lithuanian' | 'Pashto' | 'Persian' | 'Polish' | 'Portuguese' | 'Punjabi' | 'Romanian' | 'Scottish_Gaelic_Gaidhlig' | 'Slovak' | 'Somali' | 'Spanish' | 'Tigrinya' | 'Turkish' | 'Ukrainian' | 'Urdu' | 'Welsh_Cymraeg'
provider_idsinteger[] nullable
community_idsinteger[] nullable
recipient_type'User' | 'Organisation'
descriptionstring nullable
issuer_idinteger nullable
image_urlstring nullable
image_url_2xstring nullable
image_url_originalstring nullable
{"stackTrail":"components:schemas:Badge_Update:properties:design_parameters:anyOf","oasType":"schema","type":"unknown","title":"Design Parameters","nullable":true}
source'Internal' | 'Credly' | 'Open_University' | 'Imported'
earn_urlstring nullable
external_urlstring nullable
information_urlstring nullable
embedstring nullable
external_idstring nullable
latitudenumber nullable
longitudenumber nullable
citystring nullable
countrystring nullable
{"stackTrail":"components:schemas:Badge_Update:properties:config:anyOf","oasType":"schema","type":"unknown","title":"Config","nullable":true}
addressstring nullable
available_to_allboolean nullable
availabilitystring nullable
end_datestring date-time nullable
cost'Free' | 'Paid' | 'Other'
level'Foundational' | 'Intermediate' | 'Advanced' | 'Other' | 'Explore' | 'Deepen' | 'Apply' | 'Teach' | 'Lead'
time_to_earn'Hours' | 'Days' | 'Weeks' | 'Months' | 'Years' | 'Other'
participation_type'Online' | 'Hybrid' | 'In_Person'
qa_requiredboolean nullable
job_feed_enabledboolean nullable
job_feed_levelsJobLevel[] nullable
job_feed_companiesstring[] nullable
job_titlesstring[] nullable
is_demoboolean nullable
industriesstring[] nullable
occupation_groupsstring[] nullable
skill_category_namesstring[] nullable
edu_levelsstring[] nullable

Example request

{
  "description": "This badge is awarded to earners who have demonstrated their knowledge of all letters of the English alphabet.",
  "image_url": "https://media.navigatr.app/image.webp",
  "image_url_2x": "https://media.navigatr.app/image_2x.webp",
  "address": "123 Example Street, Leeds, West Yorkshire, England, LS1 EXA",
  "availability": "This badge is available to students of the University of Leeds",
  "end_date": "2023-11-18T13:33:01.201Z",
  "criteria": [
    {
      "external_id": "ABCD-EFG-HIJK-LMNOPQRS",
      "description": "Earners must have completed a three stage interview process before they can earn this badge.",
      "external_url": "https://apply.org"
    }
  ],
  "alignments": [
    {
      "external_id": "123-45678-90",
      "name": "Null Badging Standard - Example Layer",
      "description": "This badge has been mapped to the Example Layer of the Null Badging Standard",
      "url": "https://Null_Badging/Example.org"
    }
  ],
  "endorsements": [
    {
      "external_id": "zyxw-vut-srq-ponmlkjih",
      "name": "Endorsement Example",
      "description": "This is an example of a badge endorsement",
      "url": "https://Endorsement/Example.org",
      "image_url": "https://media.navigatr.app/endorsement.webp",
      "image_url_2x": "https://media.navigatr.app/endorsement_2x.webp",
      "image_url_original": "https://media.navigatr.app/endorsement_original.webp"
    }
  ],
  "tags": [
    {
      "name": "Test Driven Development"
    }
  ]
}

Response

Successful Response

namestring nullable
design_standard'Generic' | 'Navigatr'
type'Experience' | 'Learning' | 'Validation' | 'Certification' | 'Attendance' | 'Work_Experience' | 'Volunteering' | 'Job' | 'Apprenticeship' | 'Course' | 'Internship' | 'Workshop' | 'Campaigning' | 'Activism' | 'Other' | 'Informal_Learning' | 'Training' | 'Certified' | 'Qualification' | 'Membership'
language'Arabic_Modern_Standard' | 'Bengali' | 'Bulgarian' | 'Chinese_Cantonese' | 'Chinese_Mandarin' | 'Chinese_Simplified' | 'Chinese_Traditional' | 'Croatian' | 'Czech' | 'Dutch' | 'English' | 'French' | 'German' | 'Greek' | 'Hungarian' | 'Irish_Gaeilge' | 'Italian' | 'Kurdish_Kurmanji' | 'Kurdish_Sorani' | 'Latvian' | 'Lithuanian' | 'Pashto' | 'Persian' | 'Polish' | 'Portuguese' | 'Punjabi' | 'Romanian' | 'Scottish_Gaelic_Gaidhlig' | 'Slovak' | 'Somali' | 'Spanish' | 'Tigrinya' | 'Turkish' | 'Ukrainian' | 'Urdu' | 'Welsh_Cymraeg'
provider_idsinteger[] nullable
community_idsinteger[] nullable
recipient_type'User' | 'Organisation'
descriptionstring nullable
issuer_idinteger nullable
image_urlstring nullable
image_url_2xstring nullable
image_url_originalstring nullable
{"stackTrail":"components:schemas:Badge:properties:design_parameters:anyOf","oasType":"schema","type":"unknown","title":"Design Parameters","nullable":true}
source'Internal' | 'Credly' | 'Open_University' | 'Imported'
earn_urlstring nullable
external_urlstring nullable
information_urlstring nullable
embedstring nullable
external_idstring nullable
latitudenumber nullable
longitudenumber nullable
citystring nullable
countrystring nullable
{"stackTrail":"components:schemas:Badge:properties:config:anyOf","oasType":"schema","type":"unknown","title":"Config","nullable":true}
addressstring nullable
available_to_allboolean nullable
availabilitystring nullable
end_datestring date-time nullable
cost'Free' | 'Paid' | 'Other'
level'Foundational' | 'Intermediate' | 'Advanced' | 'Other' | 'Explore' | 'Deepen' | 'Apply' | 'Teach' | 'Lead'
time_to_earn'Hours' | 'Days' | 'Weeks' | 'Months' | 'Years' | 'Other'
participation_type'Online' | 'Hybrid' | 'In_Person'
qa_requiredboolean nullable
job_feed_enabledboolean nullable
job_feed_levelsJobLevel[] nullable
job_feed_companiesstring[] nullable
job_titlesstring[] nullable
is_demoboolean nullable
industriesstring[] nullable
occupation_groupsstring[] nullable
skill_category_namesstring[] nullable
edu_levelsstring[] nullable
idinteger
status'Initialising' | 'Draft' | 'Awaiting_Approval' | 'Published' | 'Deleted' | 'Expired'
rankinginteger nullable
time_createdstring date-time
time_updatedstring date-time nullable
time_submittedstring date-time nullable
time_publishedstring date-time nullable
time_issuedstring date-time nullable
created_by_idinteger nullable
submitted_by_idinteger nullable
published_by_idinteger nullable
updated_by_idinteger nullable
interacted_withboolean nullable
featuredboolean
ai_generatedboolean
urlstring
seo_keywordsstring[] nullable
seo_titlestring nullable
seo_descriptionstring nullable

Example response

{
  "name": "Learn your ABCs",
  "description": "This badge is awarded to earners who have demonstrated their knowledge of all letters of the English alphabet.",
  "image_url": "https://media.navigatr.app/image.webp",
  "image_url_2x": "https://media.navigatr.app/image_2x.webp",
  "address": "123 Example Street, Leeds, West Yorkshire, England, LS1 EXA",
  "availability": "This badge is available to students of the University of Leeds",
  "end_date": "2023-11-18T13:33:01.201Z",
  "created_by": {
    "firstname": "John",
    "lastname": "Doe",
    "avatar_url": "https://media.navigatr.app/avatar.webp",
    "avatar_url_2x": "https://media.navigatr.app/avatar_2x.webp",
    "avatar_url_original": "https://media.navigatr.app/avatar_original.webp",
    "interests": [
      "Coding, Web Development, Engineering"
    ]
  },
  "submitted_by": {
    "firstname": "John",
    "lastname": "Doe",
    "avatar_url": "https://media.navigatr.app/avatar.webp",
    "avatar_url_2x": "https://media.navigatr.app/avatar_2x.webp",
    "avatar_url_original": "https://media.navigatr.app/avatar_original.webp",
    "interests": [
      "Coding, Web Development, Engineering"
    ]
  },
  "published_by": {
    "firstname": "John",
    "lastname": "Doe",
    "avatar_url": "https://media.navigatr.app/avatar.webp",
    "avatar_url_2x": "https://media.navigatr.app/avatar_2x.webp",
    "avatar_url_original": "https://media.navigatr.app/avatar_original.webp",
    "interests": [
      "Coding, Web Development, Engineering"
    ]
  },
  "updated_by": {
    "firstname": "John",
    "lastname": "Doe",
    "avatar_url": "https://media.navigatr.app/avatar.webp",
    "avatar_url_2x": "https://media.navigatr.app/avatar_2x.webp",
    "avatar_url_original": "https://media.navigatr.app/avatar_original.webp",
    "interests": [
      "Coding, Web Development, Engineering"
    ]
  },
  "criteria": [
    {
      "external_id": "ABCD-EFG-HIJK-LMNOPQRS",
      "description": "Earners must have completed a three stage interview process before they can earn this badge.",
      "external_url": "https://apply.org"
    }
  ],
  "tags": [
    {
      "name": "Test Driven Development"
    }
  ],
  "alignments": [
    {
      "external_id": "123-45678-90",
      "name": "Null Badging Standard - Example Layer",
      "description": "This badge has been mapped to the Example Layer of the Null Badging Standard",
      "url": "https://Null_Badging/Example.org"
    }
  ],
  "endorsements": [
    {
      "external_id": "zyxw-vut-srq-ponmlkjih",
      "name": "Endorsement Example",
      "description": "This is an example of a badge endorsement",
      "url": "https://Endorsement/Example.org",
      "image_url": "https://media.navigatr.app/endorsement.webp",
      "image_url_2x": "https://media.navigatr.app/endorsement_2x.webp",
      "image_url_original": "https://media.navigatr.app/endorsement_original.webp"
    }
  ],
  "providers": [
    {
      "name": "Horace's Haberdashery Academy",
      "short_name": "HHA",
      "community": {
        "name": "Fordwich Town Council",
        "short_name": "FTC",
        "image_url": "https://media.navigatr.app/Fordwich.webp",
        "image_url_2x": "https://media.navigatr.app/Fordwich_2x.webp",
        "image_url_original": "https://media.navigatr.app/Fordwich_original.webp",
        "url": "https://navigatr.app/community/5/fordwich-town-council"
      },
      "image_url": "https://media.navigatr.app/HHA.webp",
      "banner_url": "https://media.navigatr.app/HHA_banner.webp",
      "image_url_2x": "https://media.navigatr.app/HHA_2x.webp",
      "banner_url_2x": "https://media.navigatr.app/HHA_banner_2x.webp",
      "image_url_original": "https://media.navigatr.app/HHA_original.webp",
      "banner_url_original": "https://media.navigatr.app/HHA_banner_original.webp",
      "url": "https://navigatr.app/provider/2922/horaces-haberdashery"
    }
  ],
  "url": "https://navigatr.app/badge/12345/Learn-Your-ABCs"
}