Blog

Create a blog category

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

Creates a category. Posts always belong to one, so a blog needs at least one category before its first post. 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

name string required
  • Maximum length: 255
  • Example: Product
slug string required

Lowercase letters, digits and single hyphens. Must be unique among the workspace's categories, and may not be a path another route answers on the blog's domain (v, t, r, visit, opens, track, preferences, subscribe, unsubscribe, unsubscribe-oneclick, health, healthz) or start with api, console or notification-center. A category keeps such a slug it already had.

  • Maximum length: 100
  • 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 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

201 Category created object
category object required
Show 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 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 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 or the slug is taken 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