Orbiq logoTrust Center Documentation
API v1 ReferenceCertificationsIdFiletype

Remove certification file

Detach the document or badge from a certification. With a non-default `locale` it removes that language's file instead; for `document` this also stops the…

DELETE
/api/v1/certifications/{id}/{filetype}

Detach the document or badge from a certification. With a non-default locale it removes that language's file instead; for document this also stops the language falling back to the default language's file. The removed file is only deleted once no language or version of the certification still uses it.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Certification ID

Formatuuid
filetype*string

Type of file to remove

Value in

  • "document"
  • "badge"

Query Parameters

locale?string

Locale whose file should be removed. Defaults to the tenant's default locale.

Value in

  • "en"
  • "de"
  • "fr"
  • "ja"
  • "ko"
  • "zh"

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://app.orbiqhq.com/api/v1/certifications/{id}/badge" \  -H "Authorization: Bearer $ACCESS_TOKEN"
{  "success": true,  "data": {    "message": "badge removed successfully"  }}

How is this guide?