API Reference
AppAdmin Panel

Update a post

put
https://api.happeo.com/posts/

This updates/replaces the post identified by the id that is given in the path parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

A post id.

Body Params

The body sent when creating or updating a Post

string | null

The id of the user who is the author (official writer) of the post. If not given, the user id of the user making the request is set as authorId.

string
required

The id of the channel where the post belongs to.

string
enum
required

The state of the post. The post can be in 4 different states.

  • DRAFT This is a personal draft.
  • SHARED_DRAFT This is when it is a shared draft with the editors of the channel.
  • REVIEW This is when it is being reviewed.
  • PUBLISHED This is when the post is published. It cannot revert to any other state from here.
Allowed:
string
enum
required

The layout of the post. It can be either:

  • POST This is a standard post.
  • ARTICLE This is an article layout.
Allowed:
boolean
required

True if the post is an announcement. False if not.

html | null

The content of the post.

boolean | null
Defaults to false

States whether the comments are disabled for this post.

mentionedIds
array of strings

An array of user ids that are being mentioned in the post.

mentionedIds
hashtags
array of strings

An array of hashtags attached to the post.

hashtags
attachments
array of objects | null

The array of attachments in the post.

attachments
string | null

The title of the article.

string | null

The subtitle of the article.

string | null

The position of the hero inside the article. The accepted values are BEFORE or AFTER.

hero
object

The hero used in articles.

Response

Updated 11 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago