---
title: "Unpublish badge"
method: POST
path: "/badges/{badgeId}/unpublish"
tags: ["badges"]
---

# Unpublish badge

`POST /badges/{badgeId}/unpublish`

## Request

- Base URL: `https://api.usecrouton.com`
- URL: `https://api.usecrouton.com/badges/{badgeId}/unpublish`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`
- TypeScript: <https://skmtc.dev/usecrouton/apis/crouton-api/docs/badges/:badgeId/unpublish/post.ts> (a function with typed inputs; its response is checked against the schema)

Unpublishes a badge so it is hidden and no longer awardable. Existing awards remain attached internally. The API key's associated user must be a badge administrator.

## Response `200`

The unpublished badge.

## Other responses

- `400`: 400
- `401`: Missing, invalid, revoked, or expired API key.
- `403`: API key lacks the required resource or access level.
- `404`: Badge not found
- `422`: 422

---

[API](https://skmtc.dev/usecrouton/apis/crouton-api.md) - [All operations](https://skmtc.dev/usecrouton/apis/crouton-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usecrouton/apis/crouton-api/revisions/809cbf38e25a?raw)