How to update a certificate via API

Introduction

The LMS365 API enables you to update a certificate's expiry date, issue date, and the certificate's state. 

This article describes how to update certificates via API. The updates won't affect certificate PDF files that have already been issued but certificates can be reissued via API.

 

To update the certificate, follow these steps:

Required role: Catalog admin or course admin

To be able to use the LMS365 API, you should be authorized with the relevant API key on https:/api.365.systems. For details, see this article.

1. In https:/api.365.systems, navigate to the Certificates section and expand it.

2. Select the Patch /odata​/v2​/Certificates({Id}) endpoint (this partially updates a certificate) and select Try it out.

3. In the required key: Id field, paste the certificate ID of the relevant user for the relevant course.

4. In the Certificate field, update the data of the relevant properties. You should delete the entire row for properties you don't want to update.

To update the certificate status, in the Status property, specify:

  • 0 for Valid 
  • 1 for Expiring
  • 2 for Expired 

To update the certificate's issued or expiry dates, specify the relevant dates.

properties_to_change.png

 

5. Select Execute to run the request.

6. In the Responses block, check the results:

  • Code 2xx (for example, 200) shows that the request worked correctly.
  • You can Download the data from the response to your computer in .JSON format.

the_response_block.png

 

You can track the updated certificate information in the LMS365 (Learn365) Admin Center and in the downloaded progress reports. This API call doesn't trigger changes to certificate PDF files that have already been issued.

 

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

Comments

Article is closed for comments.