> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# helpCenterCollectionUpdate

> Change a help center collection: its title, description, published state or the order of its articles. Renaming it refreshes the agent knowledge of its articles. Null when the store has no collection with this id. Throws CONFLICT when another collection has the new title, or when an article was added to or removed from the collection while an `articleOrder` was saved; nothing is written, so read the collection and send the order again. The write is saved at once; the returned object is read from the help center's read copy, which can show the previous values for a moment after the write.

**Required scopes:** [`support_help_center_write`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_help_center_write)

## Arguments

**id** `ID!` *required*

The m\_hcc\_… id.

**input** `[HelpCenterCollectionUpdateInput!](/docs/api-reference/v3/reference/support/help-center-collection-update-input)` *required*

**fields**

**articleOrder** `[ID!]`

The collection's articles (m\_hca\_… ids) in display order: exactly its current articles, each once, reordered. A list that leaves one out, repeats one or adds another is BAD\_USER\_INPUT, and an id the store has no article for is NOT\_FOUND. To move an article between collections, change its collection with helpCenterArticleUpdate.

**description** `String`

At most 2,000 characters; otherwise BAD\_USER\_INPUT.

**published** `Boolean`

Unpublishing the collection also removes the agent knowledge linked to its articles.

**title** `String`

Unique within the store, as on create (another collection's exact title is CONFLICT). Can't be blank (spaces alone count as blank) or longer than 255 characters; otherwise BAD\_USER\_INPUT.

## Returns

**helpCenterCollectionUpdate** `[HelpCenterCollection](/docs/api-reference/v3/reference/support/help-center-collection)`

A collection of help center articles, listed on one or more pages.

**fields**

**articles** `[\[HelpCenterArticle!\]!](/docs/api-reference/v3/reference/support/help-center-article)` *required*

The collection's articles in the order the merchant arranged them, each once. Includes drafts.

**Requires:** [`support_config_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_config_read)

**fields**

**collections** `[\[HelpCenterCollectionSummary!\]!](/docs/api-reference/v3/reference/support/help-center-collection-summary)` *required*

The collections that list the article, by title, each once. These are the collections shoppers find it under and whose `articles` include it. Empty when none lists it.

**Requires:** [`support_config_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_config_read)

**fields**

**description** `String!` *required*

The collection's description. Empty when none is set.

**id** `ID!` *required*

m\_hcc\_… id, the collection id in the dashboard.

**published** `Boolean!` *required*

Whether the collection itself is published.

**title** `String!` *required*

The collection's title.

**visibleToShoppers** `Boolean!` *required*

Whether shoppers see the collection: the store's help desk is on, the collection is published, a published page lists it, and it lists at least one published article.

**html** `String!` *required*

The article body as HTML, as saved in the dashboard's editor. Shoppers see it sanitized. Empty when none is saved.

**id** `ID!` *required*

m\_hca\_… id, the article id in the dashboard and in agent knowledge.

**lastEditedAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the article was last saved (the dashboard's Last updated). Null for an article never saved since that was recorded.

**published** `Boolean!` *required*

Whether the article itself is published (Published, not Draft, in the dashboard).

**title** `String!` *required*

The article's title. Empty when none is set.

**visibleToShoppers** `Boolean!` *required*

Whether shoppers see the article: it is published and listed by a collection shoppers see (`HelpCenterCollection.visibleToShoppers`).

**description** `String!` *required*

The collection's description. Empty when none is set.

**id** `ID!` *required*

m\_hcc\_… id, the collection id in the dashboard.

**pages** `[\[HelpCenterPageSummary!\]!](/docs/api-reference/v3/reference/support/help-center-page-summary)` *required*

The pages that list this collection, by title. Empty for an unassigned collection.

**Requires:** [`support_config_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_config_read)

**fields**

**description** `String`

The page's description. Null when none is set.

**id** `ID!` *required*

m\_hcp\_… id, the page id in the dashboard and in the shopper's /faq/\<page id> link.

**published** `Boolean!` *required*

Whether the page is published. Only collections on a published page show to shoppers.

**title** `String!` *required*

The page's title.

**published** `Boolean!` *required*

Whether the collection itself is published.

**title** `String!` *required*

The collection's title.

**visibleToShoppers** `Boolean!` *required*

Whether shoppers see the collection: the store's help desk is on, the collection is published, a published page lists it, and it lists at least one published article.

## Errors

Besides the [errors any request can return](https://developers.redo.com/docs/api-reference/v3/errors.md), this operation fails with these codes in `extensions.code`.

| Code | HTTP status | Meaning | Retry |
| - | - | - | - |
| `API_TOKEN_REQUIRED` | `403` | The credential has no API token to attribute the change to, such as a first-party token. Nothing was sent. | Call with a store API token. |
| `BAD_USER_INPUT` | `400` | An argument is invalid, or names something the store doesn't have. The message says which. Nothing was written. | Fix the input the message names, then send it again. |
| `NOT_FOUND` | `404` | An id the request refers to, other than its target, doesn't exist in the store. A missing target returns null instead. | Use an id that exists in the store. |
| `CONFLICT` | `409` | The change clashes with another record, such as a name already in use, and nothing was written. Or a request with the same idempotencyKey is still in progress or its outcome isn't known yet, and its write, such as an email to the customer, may already exist. | Change the clashing value, then send it again. When the message says a request with the same idempotencyKey is still in progress, wait a few seconds and send it again with the same key, which returns that request's result once it settles. Don't resend it with a new key or without one: it may write twice. |
| `INTERNAL_SERVER_ERROR` | `500` | Something failed on Redo's side. The change may or may not have been made. | Read the record to see whether the change was made before sending it again. A send with an idempotencyKey is safe to retry with the same key. |

## Example

```graphql theme={null}
mutation {
  helpCenterCollectionUpdate(id: "...", input: { ... }) {
    description
    id
    published
    title
    visibleToShoppers
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.