v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB
Degrees

Update a Specific User Degree

This endpoint updates the supplied fields for a specific degree. <h3>Required Scope</h3>degrees:write

patch/api/v2/degrees/{id}

Path parameters

idstring required

The ID of the degree to update.

Request body

Example request

{
  "data": {
    "type": "degrees",
    "id": "KAWO4",
    "attributes": {
      "title": "Bachelors of Science in IT",
      "image-url": "~/user-content/useroutcomeimage-8196-ef6c7e7b-215f-4bed-8dc0-94606049bb5c.jpg",
      "url": "https://www.example.com/award/242354",
      "college": "ABC College"
    }
  }
}

Response

Success

Example response

{
  "data": {
    "type": "degrees",
    "id": "KAWO4",
    "attributes": {
      "created-at": "2024-11-22T22:43:47.5136098",
      "title": "Bachelors of Science in IT",
      "graduated-at": "2024-11-22T17:29:29.6530591",
      "image-url": "~/user-content/useroutcomeimage-8196-ef6c7e7b-215f-4bed-8dc0-94606049bb5c.jpg",
      "url": "https://www.example.com/award/242354",
      "college": "ABC College"
    },
    "links": {
      "self": "string"
    },
    "relationships": [
      {
        "user": {
          "data": {
            "id": "4PVOL",
            "type": "users"
          }
        }
      }
    ]
  }
}