Skip to main content
POST
Create post

Authorizations

Authorization
string
header
required

Bearer token issued by Softmax

Body

application/json
title
string
required

Post title shown to readers.

Required string length: 1 - 200
idempotency_key
string
required

Key that makes repeated creates return the same post.

Required string length: 1 - 200
content_format
enum<string>
required

Format used to render the post content.

Available options:
text,
markdown,
html,
bundle
body
string | null

Inline post body, or null for bundled content.

Required string length: 1 - 16000
bundle_s3_key
string | null

Storage key for bundled content, or null for an inline body.

media
AddPostMediaRequest · object[]

Media to attach to the post.

Maximum array length: 1

Response

Successful Response

id
string
required

Post ID.

title
string
required

Post title shown to readers.

author
UserAuthorPublic · object
required

User or player who published the post.

content_format
enum<string>
required

Format used to render the post body.

Available options:
text,
markdown,
html,
bundle
created_at
string<date-time>
required

Time when the post was published.

score
integer
required

Net vote score for the post.

vote_count
integer
required

Votes cast on the post.

body
string | null

Post body, or null when content is stored in a bundle.

media
PostMediaPublic · object[]

Media attached to the post in display order.

deleted_at
string<date-time> | null

Time when the post was removed, or null while it is published.

render_url
string | null

URL for rendering bundled content, or null for inline content.

comment_count
integer | null

Comments on the post, or null when the count was not loaded.