Update a post. Provided keys are changed.

PATCHhttps://app.softsolz.uk/api/v1/services/blogs/posts/{id}

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

titlestring

Post title.

body_htmlstring

Post body as HTML.

subtitlestring

Subtitle.

excerptstring

Excerpt.

slugstring

URL slug.

categorystring

Category label.

tagsarray of strings

Tags.

authorstring

Display author/byline name.

author_image_urlstring

Byline avatar image URL.

featuredboolean

Feature this post.

no_indexboolean

Exclude from search engines.

comments_enabledboolean

Allow readers to post comments on this post.

expected_updated_atstring

Optimistic-concurrency guard; mismatch returns 409 STALE_VERSION.

Response

Response Body

idstringPost id (numeric string).

tenant_idstringOwning tenant id.

slugstringURL-safe post slug.

titlestringPost title.

subtitlestring | nullOptional subtitle.

excerptstring | nullShort excerpt.

body_htmlstringPost body as sanitized HTML.

body_formatstringBody format.

cover_image_urlstring | nullCover image URL.

cover_image_altstring | nullCover image alt text.

og_image_urlstring | nullOpen Graph image URL.

seo_titlestring | nullSEO title override.

seo_descriptionstring | nullSEO description override.

categorystring | nullCategory label.

tagsarray of stringsTags.

authorstring | nullDisplay author/byline name.

author_image_urlstring | nullByline avatar image URL.

reading_time_minutesintegerEstimated reading time.

statusstringPost status.

featuredbooleanWhether the post is featured.

no_indexbooleanExcluded from search engines.

comments_enabledbooleanWhether comments are open on this post.

show_tocbooleanWhether a table of contents is shown on this post.

show_sharebooleanWhether reader share buttons are shown.

show_datebooleanWhether the publish date is shown.

show_reading_timebooleanWhether the reading time is shown.

cta_labelstring | nullOptional call-to-action label.

cta_urlstring | nullOptional call-to-action URL.

view_countstringTotal view count (numeric string).

published_atstring | nullWhen the post was published; null until then.

scheduled_forstring | nullWhen the post is scheduled to publish; null unless scheduled.

created_byinteger | nullUser id that created the post.

created_atstringCreation timestamp.

updated_atstringLast update timestamp.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.blogs.updatePost('<id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "id": "string",
    "tenant_id": "string",
    "slug": "string",
    "title": "string",
    "subtitle": "string",
    "excerpt": "string",
    "body_html": "string",
    "body_format": "string",
    "cover_image_url": "string",
    "cover_image_alt": "string",
    "og_image_url": "string",
    "seo_title": "string",
    "seo_description": "string",
    "category": "string",
    "tags": [],
    "author": "string",
    "author_image_url": "string",
    "reading_time_minutes": 0,
    "status": "string",
    "featured": true,
    "no_index": true,
    "comments_enabled": true,
    "show_toc": true,
    "show_share": true,
    "show_date": true,
    "show_reading_time": true,
    "cta_label": "string",
    "cta_url": "string",
    "view_count": "string",
    "published_at": "string",
    "scheduled_for": "string",
    "created_by": 0,
    "created_at": "string",
    "updated_at": "string"
  }
}