---
title: "Publish or unpublish a collection's articles"
url: https://docs.gleap.ai/en/reference/rest-api/unpublish-helpcenter-collection
method: PUT
path: "/helpcenter/collections/{helpcenterCollectionId}/toggle-publish"
api: "API Reference"
tag: "Help center collections"
operationId: "UnpublishHelpcenterCollection"
updatedAt: "2026-11-01T18:40:15.677Z"
language: en
---

# Publish or unpublish a collection's articles

`PUT https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/toggle-publish`

Publish or unpublish every article in a help center collection. Set `unpublished` to `true` to unpublish or `false` to publish; the change is applied recursively to all articles in this collection and in all of its subcollections. The collection document itself is not modified. Returns `{ success: true }`.

## Authorization

- `Authorization` (header, required): `Bearer <token>`

## Path parameters

- `helpcenterCollectionId` (string, required)

## Headers

- `project` (string, required)

## Request body (`application/json`, required)

- `unpublished` (boolean, required)

## Example request

```bash
curl --request PUT \
  --url 'https://api.gleap.io/v3/helpcenter/collections/{helpcenterCollectionId}/toggle-publish' \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>' \
  --header 'Content-Type: application/json' \
  --data '{
  "unpublished": true
}'
```

## Responses

### 200 (`application/json`)

Ok

- `success` (boolean, required)

```json
{
  "success": true
}
```
