Skip to contentDevelopersPrezly website
Newsroom categories

Update Newsroom Category

Update selected category translations and presentation fields.

Personal token scopes: sites:write. Your account must also have access to the requested data. Authentication

Translation removal is nested under i18n, for example {"i18n":{"nl":null}}. Omitted translations remain unchanged.

Read the guide

PATCH
/newsrooms/{newsroom_id}/categories/{id}

Partially update a category. Remove a translation with the i18n wrapper: {"i18n":{"en_BE":null}}. Omitted locales remain unchanged. Image and featured status are independent of translations.

Personal access tokens: sites:write. Every listed scope is required; the token owner's permissions, feature availability and newsroom access still apply.

Authorization

API_key
headerAuthorizationBearer <token>

Bearer authentication using an integration API key, or a personal access token only where the operation explicitly supports it. Every listed personal-token scope is required; owner permissions and newsroom access still apply.

Path Parameters

id*integer

Category ID

newsroom_id*string

Newsroom UUID or ID

Length1 <= length

Request Body

application/json
  1. body
i18n?

Translations keyed by supported locale code. Omitted locales are preserved on PATCH; null removes a translation.

image?||
is_featured?boolean

Response Body

OK

application/json
  1. response
category?

Categories are used to categorise content in a Newsroom.

Note: Categories are visible publicly on the newsroom website.

Example Request
curl -X PATCH 'https://api.prezly.com/v2/newsrooms/string/categories/0' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
{  "category": {    "id": 0,    "display_name": "string",    "display_description": "string",    "i18n": {      "[a-z]{2,3}(_[A-Z][a-z]{3})?(_[A-Z]{2})?": {        "name": "string",        "description": "string",        "slug": "string",        "locale": {          "code": "en",          "name": "string",          "direction": "ltr",          "language_code": "en",          "native_name": "string"        }      }    },    "stories_number": 0  }}