Change the title and URL of a course catalog via API

With the Learn365 API, you can change the title and URL of a course catalog.

This function is helpful, for example, when you've created a course catalog in your test environment and you plan to move it to your production environment. In this case, you'll need to change the course catalog URL and might also want to change the course catalog title.

Changing the catalog title and URL involves renaming the existing catalog and change its URL in SharePoint, and renaming the catalog and changing its URL in Learn365 via API.

This article describes these steps:

Step #1. Change the catalog title and URL in SharePoint

Step #2. Change the catalog title and URL in Learn365 via the API

Step #3. View changes in the Learn365 Admin Center

Step #1. Change the catalog title and URL in SharePoint

Required role: Microsoft 365 global admin or SharePoint admin

To change the title of the existing course catalog and its URL in SharePoint, follow these Microsoft instructions. Copy the new catalog title and URL to use in the next step.

Step #2. Change the course catalog title and URL in Learn365 via the API

PATCH /odata/v2/CourseCatalogs({Id})

Pre-Conditions

To send the request, you'll need an API key.

To change the course catalog title and URL, you’ll need the course catalog ID. You can find this via API by following the steps in this article.

Request body parameters

• Title (string). The new course catalog title mentioned in Step #1.
• URL (string). The new course catalog URL mentioned in Step #1.

Request example

PATCH /odata/v2/CourseCatalogs({Id})
{
"Title": "Test Course Catalog",
"URL": "https://test.sharepoint.com/sites/TestCourseCatalog"
}

Response

A 200 response means a successful request. The course catalog title and URL are updated.

Step #3. View changes in the Learn365 Admin Center

As a result of a successful request, the URL and the title of the catalog are changed immediately. You can track this in the Learn365 Admin Center > Course catalog management.