Create a Changelog Entry - Suggix Help Center

`POST /changelogs`

Creates and immediately publishes a changelog entry in the API key’s workspace. The endpoint always publishes the entry; it does not accept is_published or a scheduled publication time. The creator is the workspace member who created the key.

Headers

Header	Value
`Authorization`	`Bearer sgx_api_your_key` (or send the key in `X-API-Key`)
`Content-Type`	`application/json`

Request body

Field	Type	Required	Description
`title`	string	Yes	Changelog title, 1 to 255 characters.
`text`	string	No	Markdown content. It is converted to Suggix’s rich text format.

Request

POST https://www.suggix.com/v1/changelogs
Authorization: Bearer sgx_api_your_key
Content-Type: application/json

{
  "title": "Version 2.4 is here",
  "text": "## What's new\n\n- Faster search\n- Improved notifications"
}

Successful response

201 Created returns a changelog object with creator details.

{
  "id": 76,
  "workspace_id": 7,
  "creator_id": 14,
  "creator_name": "Alex",
  "creator_email": "alex@example.com",
  "creator_photo_url": "https://example.com/avatar.png",
  "title": "Version 2.4 is here",
  "url": "version-24-is-here",
  "text": "{\"time\":1791609328716,\"blocks\":[...],\"version\":\"2.31.6\"}",
  "html": "<div class=\"ce-block\">...</div>",
  "preview": "What's new\n\nFaster search\nImproved notifications",
  "likes": 0,
  "views": 0,
  "publish_at": 1791609328765,
  "created_at": 1791609328765,
  "updated_at": 1791609328765
}

Response fields

Field	Type	Description
`id`, `workspace_id`, `creator_id`	integer	Changelog, workspace, and creator identifiers.
`creator_name`, `creator_email`, `creator_photo_url`	string	Creator details; optional values may be omitted.
`title`, `url`	string	Changelog title and URL slug.
`text`	string	Serialized Editor.js document JSON generated from the Markdown input.
`html`, `preview`	string	Rendered content and plain-text preview; may be omitted when empty.
`likes`, `views`	integer	Like and view counts.
`publish_at`	integer	Publication timestamp in Unix milliseconds. This endpoint publishes immediately.
`created_at`, `updated_at`	integer	Record timestamps in Unix milliseconds.
`deleted_at`	integer	Deletion timestamp in milliseconds; omitted when not deleted.
`liked`	boolean	Whether the API key owner liked the changelog; may be omitted when false.

Errors

HTTP status	Response	Cause
`400`	`{"error":"invalid request body"}`	The body is not valid JSON.
`400`	`{"error":"invalid title"}`	The title is empty or longer than 255 characters.
`400`	`{"error":"..."}`	The content could not be processed; `error` contains the reason.
`401`	`{"error":"invalid or missing API key"}`	The API key is absent or invalid.

​POST /changelogs

​Headers

​Request body

​Request

​Successful response

​Response fields

​Errors