POST
/
posts
Create a new post
curl --request POST \
  --url http://localhost:3001/portal-api/posts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "Content": "# Title\r\n## Subtitle\r\nContent goes here",
  "MarkdownEnabled": true,
  "Status": "published",
  "Title": "Get started this API Product",
  "Lede": "<string>",
  "Path": "<string>",
  "Categories": [
    "<string>"
  ],
  "Tags": [
    "<string>"
  ],
  "MarkdownContent": "<string>",
  "PreviewContent": "<string>"
}'
{
  "ID": "<string>",
  "Title": "<string>",
  "Lede": "<string>",
  "Content": "<string>",
  "Status": "<string>",
  "Path": "<string>",
  "Categories": [
    {
      "ID": "<string>",
      "Name": "<string>",
      "CreatedAt": "2023-06-25 13:37",
      "UpdatedAt": "2023-06-25 13:37"
    }
  ],
  "Tags": [
    {
      "ID": "<string>",
      "Name": "<string>",
      "CreatedAt": "2023-06-25 13:37",
      "UpdatedAt": "2023-06-25 13:37"
    }
  ],
  "MarkdownEnabled": true,
  "MarkdownContent": "<string>",
  "PreviewContent": "<string>",
  "CreatedAt": "2023-06-25 13:37",
  "UpdatedAt": "2023-06-25 13:37"
}

Authorizations

Authorization
string
header
required

Body

application/json
Content
string

Full content of the post

Example:

"# Title\r\n## Subtitle\r\nContent goes here"

MarkdownEnabled
boolean

Whether Markdown is enabled for this post

Example:

true

Status
enum<string>

Status of the post (e.g., draft, published)

Available options:
published,
draft,
review
Example:

"published"

Title
string

Title of the post

Example:

"Get started this API Product"

Lede
string

Short summary or lead paragraph of the post

Path
string

URL path for the post

Categories
string[]

List of category IDs to associate with the post

Tags
string[]

List of tag IDs to associate with the post

MarkdownContent
string

Content of the post in Markdown format, if Markdown is enabled

PreviewContent
string

Preview content of the post

Response

201 - application/json

Created

ID
string

Unique identifier for the post

Title
string

Title of the post

Lede
string

Short summary or lead paragraph of the post

Content
string

Full content of the post

Status
string

Status of the post (e.g., draft, published)

Path
string

URL path for the post

Categories
object[]

List of categories associated with the post

Tags
object[]

List of tags associated with the post

MarkdownEnabled
boolean

Whether Markdown is enabled for this post

MarkdownContent
string

Content of the post in Markdown format, if Markdown is enabled

PreviewContent
string

Preview content of the post

CreatedAt
string

Timestamp of when this post was created

Example:

"2023-06-25 13:37"

UpdatedAt
string

Timestamp of when this post was last updated

Example:

"2023-06-25 13:37"