System Status
  1. Help Center
  2. REST API, Power BI, and Power Automate
  3. Create and delete via API

Purge skills via the API

Avatar

It’s possible to purge skills from the Learn365 tenant via API, therefore completely removing this information.

 

NOTE  

We've implemented new Skills endpoints that will eventually replace the corresponding Competency endpoints. You can continue to use the legacy Competency endpoints until we deprecate them as part of the Learn365 (v.3.64) release, which is currently scheduled for Monday, August 18, 2025.

We advise you to start planning for the deprecation of the Competency endpoints and migrating to the new Skills endpoints. This is to ensure that, if you encounter any issues or errors, they can be resolved by the time we deprecate the endpoints.

 

This article describes how to purge a skill via new, as well as legacy endpoints.

 

NOTE   

  • You can purge both valid and revoked skills.
  • Purging one skill in a multi-level skill chain purges the entire chain.

 

Before purging a skill, you’ll need the:

  • LoginName of the user whose skill you want to purge. You can find this via the API by following the steps in this article.
  • skillId or competencyId. This is the ID of the skill you want to purge. You can find this via the API by following the steps in this article.

 

Purge a user's skill via the UserSkills endpoint

1. Go to https://api.365.systems/ and make sure you are authorized with the relevant API key.

2. In the UserSkills section, select the POST /services/skills/catalog/{courseCatalogId}/UserSkills/User/{userLoginName}/PurgeSkill endpoint and select Try it out in the top right-hand corner.

 

swagger_purge_skill

 

3. In the userLoginName field, enter the user@domain.com part of the user's login name.

4. In the request body, enter the skillId, which is the ID of the skill you want to purge.

 

swagger_purge_skill_example

 

5. Select Execute to run the request.

6. Go to the Response block to check the results:

  • 204 code without parameters in its body means a successful response.
  • In case of an error, the response body contains the error object with the code and message keys explaining the issue.

 

swagger_purge_skill_via_api_response

 

You can check the Audit Trail to see more information about the purged skill.

7. Go to the Learn365 Admin Center > Global Settings > Audit Trail.

8. Find and select the last record with the Learner skill level was purged activity name to see more information.

 

audit_trail_skill_purged_via_api_more_information

 

Purge a user's skill via the Users endpoint (legacy)

1. Go to https://api.365.systems/ and make sure you are authorized with the relevant API key.

2. In the Users section, select the POST /odata/v2/Users(‘{LoginName}’)/PurgeCompetency endpoint and select Try it out in the top right-hand corner.

 

Purge a skill endpoint

 

3. Enter the LoginName and competencyId.

 

Purge a skill request

 

4. Select Execute to run the request.

5. Go to the Response block to check the results:

  • 202 code without parameters in its body means a successful response.
  • In case of an error, the response body contains the error object with the code and message keys explaining the issue.

You can check the Audit Trail to see more information about the purged skill.

6. Go to the Learn365 Admin Center > Global Settings > Audit Trail.

7. Find and select the last record with the Learner skill level was purged activity name to see more information.

 

Purge a skill audit trail

 

You can find more information about the Audit Trail in this article.

 

Was this article helpful?
0 out of 0 found this helpful

Comments

Article is closed for comments.