Skip to navigation

Set a badge on a workbook (Beta)

View as Markdown

Set or replace the badge on a workbook.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Usage notes

  • Retrieve the workbookId by calling the /v2/workbooks endpoint.
  • To perform this operation, you must use API credentials owned by a user assigned to an account type with the Manage all badges permission.
  • If workbookId is the ID of a tagged version of a workbook (taggedWorkbookId), the badge is set on the original workbook. Tagged versions do not have their own badges.
  • Omit badgeNote to clear the current note. Pass badgeNote to replace the current note. Returns an empty string when the badge has no note.
  • Pass the badge returned by the /v2/files endpoint. That endpoint returns null when the document has no badge.

Usage scenarios

  • Certification: Set a workbook to Endorsed when it is verified, trusted, and meets your quality standards.
  • Lifecycle: Set a workbook to Warning when it is outdated, incomplete, or under review, and to Deprecated when it is obsolete or no longer maintained.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
Unique identifier of the workbook.

Request

The request body.
badgeenumRequired
Badge shown on the workbook.
Allowed values:
badgeNotestringOptional
Note shown with the badge.

Response

The response body.
badgeenum
Badge shown on the workbook.
Allowed values:
badgeNotestringOptional
Note shown with the badge.