Blog

Update a blog post

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

Replaces a post's metadata. This is not a patch: optional fields left out are cleared, so send the post back with your changes applied.

To change the body, update the template with templates.update, which saves a new template version. A post pinned to a template_version keeps rendering the old one until you update the post with the new version; a post at version 0 follows the latest version on its own, within the 5-minute page cache.

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

category_id string required

An existing category.

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

Lowercase letters, digits and single hyphens. Must be unique across the whole workspace, not just within the category.

  • Maximum length: 100
  • Example: october-release
title string required
  • Maximum length: 500
  • Example: What shipped in October
template_id string required

A web template (channel: web) holding the post body — create it first with templates.create. Its existence is not checked here: a post pointing at a missing template is saved and renders with an empty body.

  • Example: blog_october_release
template_version integer

The template version to render. Omit it (or send 0) to always render the template's latest version; pin a version to control exactly when a template edit reaches readers.

  • Default: 0
  • Example: 1
excerpt string
  • Example: A faster editor, scheduled broadcasts and a new API.
featured_image_url string
  • Example: https://cdn.example.com/blog/october.png
authors object[]
Show child attributes
name string required
  • Example: Jane Doe
avatar_url string
  • Example: https://cdn.example.com/avatars/jane.png
reading_time_minutes integer
  • Example: 4
seo object

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

Show 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
id string required
  • Example: 1b4e28ba-2fa1-11d2-883f-0016d3cca427

Response

200 Post updated object
post object required
Show child attributes
id string required

Server-generated UUID.

  • Example: 1b4e28ba-2fa1-11d2-883f-0016d3cca427
category_id string required
  • Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
slug string required

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

  • Example: october-release
settings object required
Show child attributes
title string required

The post's H1.

  • Example: What shipped in October
template object required

The web template holding the post body.

Show child attributes
template_id string required
  • Example: blog_october_release
template_version integer required

The template version the post renders. 0 means the latest version, whatever it is at render time.

  • Example: 3
excerpt string
  • Example: A faster editor, scheduled broadcasts and a new API.
featured_image_url string
  • Example: https://cdn.example.com/blog/october.png
authors object[] | null
Show child attributes
name string required
  • Example: Jane Doe
avatar_url string
  • Example: https://cdn.example.com/avatars/jane.png
reading_time_minutes integer required

Displayed as given; not computed from the body.

  • Example: 4
seo object

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

Show 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
published_at string<date-time>

Absent while the post is a draft.

  • Example: 2026-10-01T09:00:00Z
created_at string<date-time> required
updated_at string<date-time> required
400 Bad request - validation failed, slug taken, or post 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.

  • Available options: read, write