Blog

Update a blog category

POST https://demo.notifuse.com/api/blogCategories.update

Replaces a category's name, slug, description and SEO settings. This is not a patch: optional fields left out are cleared. Public pages are cached for up to 5 minutes, so a rename can take that long to show on the blog. Requires the blog write permission.

Authorizations

Authorization string header required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Query Parameters

workspace_id string required

The ID of the workspace. Passed in the query string, not the body.

Example ws_1234567890

Body application/json

id string required
Example 7c9e6679-7425-40de-944b-e07fc1f90ae7
name string required
Max length 255 Example Product
slug string required

Changing it changes the URL of the category page and of every post in it. No redirect is created from the old URLs. A new slug may not be one another route answers on the blog's domain (see the create request); a category keeps such a slug it already had.

Max length 100 Example product
description string
seo object

Search and social metadata for the page, exposed to the blog theme.

Show 8 child attributes Hide 8 child attributes
meta_title string
Example Release notes for October
meta_description string
Example Everything that shipped this month.
og_title string

Open Graph title

og_description string

Open Graph description

og_image string

Open Graph image URL

Example https://cdn.example.com/og/october.png
canonical_url string
Example https://blog.example.com/product/october-release
keywords string[]
meta_robots string

Content of the robots meta tag.

Example index,follow

Response

200 Category updated object
category object required
Show 5 child attributes Hide 5 child attributes
id string required

Server-generated UUID.

Example 7c9e6679-7425-40de-944b-e07fc1f90ae7
slug string required

The category's path segment on the blog (/{category_slug}).

Example product
settings object required
Show 3 child attributes Hide 3 child attributes
name string required
Example Product
description string
Example Release notes and product announcements.
seo object

Search and social metadata for the page, exposed to the blog theme.

Show 8 child attributes Hide 8 child attributes
meta_title string
Example Release notes for October
meta_description string
Example Everything that shipped this month.
og_title string

Open Graph title

og_description string

Open Graph description

og_image string

Open Graph image URL

Example https://cdn.example.com/og/october.png
canonical_url string
Example https://blog.example.com/product/october-release
keywords string[]
meta_robots string

Content of the robots meta tag.

Example index,follow
created_at string<date-time> required
updated_at string<date-time> required
400 Bad request - validation failed, slug taken or category not found object
error string required

Error message

401 Unauthorized - invalid or missing authentication token object
error string required

Error message

403 Forbidden - missing the blog write permission object
error string required

Error message

resource string required

The permission resource the endpoint requires.

Example blog
permission string required

The access level the endpoint requires on that resource.

Options read, write