Sign in
latestOpenAPI 3.0.12026-08-1091181421.2 KB

44eb39b4bd65

Pathways

Update pathway draft

put/v2/pathways/{id}/versions/draft

Path parameters

idstring required

Request body

issuerIdstring required

Example request

{
  "root": {
    "alignmentUrl": "www.example.com/skills/E1",
    "children": [],
    "completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
    "description": "Complete Math 101 course",
    "elementId": "65aa04adf5afe00d0a6dac72",
    "frameworkName": "OSMT",
    "name": "Math 101",
    "requirements": {
      "badgeRequirements": {
        "requiredBadges": [
          {
            "badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw"
          }
        ]
      },
      "courseRequirements": {
        "requiredCourses": [
          {
            "completionRequirement": {
              "minThreshold": 0.81
            },
            "courseId": "123678",
            "domain": "canvas.instructure.com",
            "name": "Math 101",
            "url": "https://canvas.instructure.com/courses/123678"
          }
        ]
      },
      "experienceRequirements": {
        "requiredExperiences": [
          {
            "description": "Attend Instructure Conference 2025",
            "name": "Conference"
          }
        ]
      }
    },
    "shortCode": "M101",
    "targetCode": "E1"
  }
}

Response

OK

creationDatestring date-time required
draftLastUpdatedAtstring date-time required
draftStructureVersioninteger required
hasDraftChangesboolean required
hasThirdPartyBadgesboolean required
issuerIdstring required

ID of the issuer where the pathway was created

lastPublishedAtstring date-time nullable
pathwayIdstring nullable

Example response

{
  "issuerId": "62aa04adf5afe00d0a6dac72",
  "pathwayId": "66aa04adf5afe00d0a6dac72",
  "root": {
    "alignmentUrl": "www.example.com/skills/E1",
    "children": [],
    "completionBadge": "https://api.staging.badgr.dev/public/badges/ngurEbvbQiCAs5EkwEgIBw",
    "description": "Complete Math 101 course",
    "elementId": "65aa04adf5afe00d0a6dac72",
    "frameworkName": "OSMT",
    "name": "Math 101",
    "requirements": {
      "badgeRequirements": {
        "requiredBadges": [
          {
            "badgeUrl": "https://api.badgr.io/public/badges/ngurE1vbQiCAs5EkwEgIBw"
          }
        ]
      },
      "courseRequirements": {
        "requiredCourses": [
          {
            "completionRequirement": {
              "minThreshold": 0.81
            },
            "courseId": "123678",
            "domain": "canvas.instructure.com",
            "name": "Math 101",
            "url": "https://canvas.instructure.com/courses/123678"
          }
        ]
      },
      "experienceRequirements": {
        "requiredExperiences": [
          {
            "description": "Attend Instructure Conference 2025",
            "name": "Conference"
          }
        ]
      }
    },
    "shortCode": "M101",
    "targetCode": "E1"
  }
}