---
title: "Update a Specific Required Learning"
method: PATCH
path: "/api/v2/required-learning/{id}"
tags: ["RequiredLearning"]
---

# Update a Specific Required Learning

`PATCH /api/v2/required-learning/{id}`

This endpoint updates supplied fields for a specific required learning. <h3>Required Scope</h3>`required_learning:write`

## Path parameters

- `id` string, required

## Request body

- RequiredlearningIdBody
  - `data` Apiv2requiredlearningData
    - `type` string
    - `attributes` Apiv2requiredlearningDataAttributes
      - `user-id` string, nullable, required — The ID of the user to assign the content item to.
      - `user-identifier-type` string, nullable, required — Can be any `UserId`,` Email`, `EmployeeId`, `AliasUid`, or `AliasEmail`.
      - `assigner-id` string, nullable — The ID of the user that assigned the content item. The user must have the Assign Content permission.
      - `assigner-identifier-type` string — Can be any `UserId`,` Email`, `EmployeeId`, `AliasUid`, or `AliasEmail`.
      - `content-id` string, nullable, required — The unique ID of the content.
      - `content-id-type` string, nullable, required — Can be `ExternalId`, `Id`, or `ContentUrl`.
      - `content-type` string, required — Can be `Article`, `Book`, `Course`, `Event`, or `Video`.
      - `assignment-type` string, nullable, required — Can be `Required` or `Assigned`. If the `assignment-type` is `required`, an `assigner-id` is not allowed. If the `assignment-type` is `assigned`, an `assigner-id` is required.
      - `due-at` string, date-time, nullable — Date and time for when the assignment is due.

## Response `200`

Success

- DetailedRequiredLearning
  - `data` DetailedRequiredLearningData
    - `id` string, nullable
    - `type` string, nullable
    - `attributes` DetailedRequiredLearningDataAttributes
      - `users` DetailedRequiredLearningDataAttributesUsers[], nullable
        - `userId` string, nullable
        - `employeeId` string, nullable
      - `assignment-type` string, nullable — Can only be `Assigned` or `Required`.
      - `status` string, nullable — The status of the required learning item. Can only be `Queued`, `Pending`, `Dismissed` or `Complete`.
      - `due-at` string, date-time — The date the required learning item is due.
      - `created-at` string, date-time — The date the required learning item was created.
      - `modified-at` string, date-time, nullable — The date the required learning item was modified.
      - `comment` string, nullable — A comment on the required learning item.
      - `assigner-employee-id` string — The employee id of the user that assigned the content.
    - `links` SelfLink
      - `self` string
    - `relationships` DetailedRequiredLearningDataRelationships[]
      - `content` ListedRequiredLearningDataContent
        - `data` ListedRequiredLearningDataContentData
          - `id` string
          - `type` string
      - `provider` ListedRequiredLearningDataProvider
        - `data` ListedRequiredLearningDataProviderData
          - `id` string
          - `type` string
      - `required-learning-collection` ListedRequiredLearningDataRequiredlearningcollection
        - `data` ListedRequiredLearningDataRequiredlearningcollectionData
          - `id` string
          - `type` string
      - `assigner` DetailedRequiredLearningDataAssigner
        - `data` DetailedRequiredLearningDataAssignerData
          - `id` string — The id of the user that assigned the content.
          - `type` string
    - `included` RequiredLearningContentIncludedInner[] — More information about the required learning resource.
      - `type` string, nullable
      - `id` string, nullable
      - `attributes` RequiredLearningContentIncludedInnerAttributes
        - `content-type` string, nullable — The content type of the required learning resource.
        - `url` string, nullable — URL location of the required learning resource.
        - `title` string, nullable — The title of the required learning resource.
        - `provider` string, nullable — The provider of the required learning resource.
        - `degreed-url` string — URL location of content within Degreed UI.
      - `links` SelfLink
        - `self` string

---

[API](https://skmtc.net/degreed/apis/degreed-api-web.md) · [All operations](https://skmtc.net/degreed/apis/degreed-api-web/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/degreed/degreed-api-web/revisions/4a22b709515c/schema)
