# Update category

<mark style="color:purple;">`PUT`</mark> `https://app.ecwid.com/api/v3/{storeId}/categories/{categoryId}`&#x20;

<details>

<summary>Request and response example</summary>

Request:

```http
PUT /api/v3/1003/categories/9691094 HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com
Content-Type: application/json
Cache-Control: no-cache

{
  "description": "Temporary hidden",
  "enabled": false
}
```

Response:

```json
{
  "updateCount": 1
}
```

</details>

### Required access scopes

Your app must have the following **access scopes** to make this request: `update_catalog`

### Path params

All path params are required.

| Param      | Type   | Description           |
| ---------- | ------ | --------------------- |
| storeId    | number | Ecwid store ID.       |
| categoryId | number | Internal category ID. |

### Headers

The **Authorization** header is required.

<table><thead><tr><th>Header</th><th width="252">Format</th><th>Description</th></tr></thead><tbody><tr><td>Authorization</td><td><code>Bearer secret_ab***cd</code></td><td>Access token of the application.</td></tr></tbody></table>

### Request JSON

A JSON object with the following fields:

| Field                   | Type                                 | Description                                                                                                                                                              |
| ----------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| parentId                | number                               | ID of the parent category, if any.                                                                                                                                       |
| productIds              | array of numbers                     | IDs of products assigned to the category as they appear in [Ecwid admin > Catalog > Categories](https://my.ecwid.com/#category). Requires `productIds=true` query param. |
| orderBy                 | number                               | Sorting order of the category. Starts from `10` and increments by `10`.                                                                                                  |
| name                    | string                               | Category name visible on the storefront.                                                                                                                                 |
| nameTranslated          | object [translations](#translations) | Available translations for the category name.                                                                                                                            |
| description             | string                               | Category description in HTML format.                                                                                                                                     |
| descriptionTranslated   | object [translations](#translations) | Available translations for the category description.                                                                                                                     |
| seoTitle                | string                               | SEO page title for web search results. Recommended length is under 55 characters.                                                                                        |
| seoTitleTranslated      | string                               | SEO page title translations.                                                                                                                                             |
| seoDescription          | string                               | SEO page description for web search results. Recommended length is under 160 characters.                                                                                 |
| seoDecriptionTranslated | string                               | SEO page description translations.                                                                                                                                       |
| enabled                 | boolean                              | `true` if the category is enabled, `false` otherwise. Use `hidden_categories` in request to get disabled categories                                                      |
| customSlug              | string                               | Custom slug for the category page URL.                                                                                                                                   |
| externalReferenceId     | string                               | <p>Internal field for Lightspeed X-Series connection.<br><br>This ID is unique for each category in one store.</p>                                                       |

#### translations

Object with text field translations in the `"lang": "text"` format, where the `"lang"` is an ISO 639-1 language code. For example:

```
{
    "en": "Sample text",
    "nl": "Voorbeeldtekst"
}
```

Translations are available for all active store languages. Only the default language translations are returned if no other translations are provided for the field. Find active store languages with <mark style="color:green;">`GET`</mark> `/profile` request > `languages` > `enabledLanguages`.

### Response JSON

A JSON object with the following fields:

| Field       | Type   | Description                                                                                                                                                                                   |
| ----------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| updateCount | number | <p>The number of updated items that defines if the request was successful.<br><br>One of:</p><p><code>1</code> if the item was updated,</p><p><code>0</code> if the item was not updated.</p> |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ecwid.com/api-reference/rest-api/categories/update-category.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.