BCdiploma Knowledge BaseBCdiploma Knowledge Base
User guide
Technical guide
API
Terms and Data
  • English
  • Français
User guide
Technical guide
API
Terms and Data
  • English
  • Français
  • API

    • How to use BCdiploma API
    • Automate issuing process
    • Deletions and revocations
    • Update
    • Certificate Template Management
    • Learning Pathway Management
    • Download
    • Data Export
    • Miscellaneous APIs
    • Management of errors

Update

API to update a certificate's email address

Updating the email address associated with a certificate is possible via a PUT request to the endpoint [API-URL]/admin/email.

Required HTTP header: Content-Type: application/json

The request body must be a JSON object containing the following required fields:

  • id: The unique identifier of the certificate to update (EvidenzId)
  • email: The new email address
{
    "id": <EvidenzId>,
    "email": "new-address@domain.com"
}

Warning

This API cannot be used with micro-certificates or templates that comply with the Open Badges standard. In these cases, the recipient’s email address is an integral part of the certificate data and cannot be updated.

Prev
Deletions and revocations
Next
Certificate Template Management