Sign in

v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB
Recommended Learning

Create a New Recommended Learning Item

This endpoint creates a new recommended learning item. <br><br>For Global Admin Tool Organizations, the X-Degreed-Organization-Code header must be provided.<h3>Required Scope</h3>recommended_learning:write

post/api/v2/recommended-learning

Headers

X-Degreed-Organization-Codestring
Example:tenant_organization_code

For Global Admin Tool Organizations, this header can be included in your request to create recommended learning items for the tenant organization, but it is not required and may limit the content for which the recommendation can be created. You must provide your organization code as the value. Contact your Degreed technical partner if you are unsure what your organization code is.

Request body

Example request

{
  "data": {
    "type": "recommended-learning",
    "attributes": {
      "user-id": "info@example.com",
      "user-identifier-type": "email",
      "assigner-id": "info@example.com",
      "assigner-identifier-type": "email",
      "content-id": "nNmwVAgd",
      "content-id-type": "id",
      "content-type": "video",
      "assignment-type": "Recommendation",
      "status": "Pending"
    }
  }
}

Response

Success

Example response

{
  "data": {
    "type": "recommended-learning",
    "id": "Yxjak6",
    "attributes": {
      "user-id": "info@example.com",
      "user-identifier-type": "email",
      "assigner-id": "info@example.com",
      "assigner-identifier-type": "email",
      "content-id": "nNmwVAgd",
      "content-id-type": "id",
      "content-type": "video",
      "status": "Pending"
    },
    "links": {
      "self": "/recommended-learning/Yxjak6"
    }
  }
}