Set a badge on a workbook (Beta)
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
badgeNoteto clear the current note. PassbadgeNoteto replace the current note. Returns an empty string when the badge has no note. - Pass the
badgereturned by the /v2/files endpoint. That endpoint returnsnullwhen the document has no badge.
Usage scenarios
- Certification: Set a workbook to
Endorsedwhen it is verified, trusted, and meets your quality standards. - Lifecycle: Set a workbook to
Warningwhen it is outdated, incomplete, or under review, and toDeprecatedwhen it is obsolete or no longer maintained.
Authentication
AuthorizationBearer
OAuth authentication of the form <token>.
Path parameters
workbookId
Unique identifier of the workbook.
Request
The request body.
badge
Badge shown on the workbook.
Allowed values:
badgeNote
Note shown with the badge.
Response
The response body.
badge
Badge shown on the workbook.
Allowed values:
badgeNote
Note shown with the badge.

