Post interactions

Available methods:

See also:

Report a post

Required API scope: interactions. Read access to the post must be present too (public:read for public posts and private:read for private posts).

Request

POST /api/v1/posts/:post_guid/report
{
  "reason": "This post is spam."
}

Parameters

Name Type Description
reason string The reason behind reporting this post.

Response

Status: 204 No Content

Errors

Status code Error reason
404 Post with provided guid could not be found
409 Post has already been reported
422 Request invalid, such as a missing reason

Subscribe to a post

The current user will receive notifications for subscribed posts without adding a like or comment.

Required API scope: interactions. Read access to the post must be present too (public:read for public posts and private:read for private posts).

Request

POST /api/v1/posts/:post_guid/subscribe

Response

Status: 204 No Content

Errors

Status code Error reason
404 Post with provided guid could not be found
409 Already subscribed
422 Request invalid

Mute (unsubscribe from a) a post

The current user will not receive any notifications for this post, even if a comment or like was added.

Required API scope: interactions. Read access to the post must be present too (public:read for public posts and private:read for private posts).

Request

POST /api/v1/posts/:post_guid/mute

Response

Status: 204 No Content

Errors

Status code Error reason
404 Post with provided guid could not be found
410 Was not subscribed to this post
422 Request invalid

Hide or unhide a post

The given post will be excluded from all streams and search results.

Required API scope: interactions. Read access to the post must be present too (public:read for public posts and private:read for private posts).

Request

POST /api/v1/posts/:post_guid/hide
{
  "hide": true
}

Parameters

Name Type Description
hide boolean Whether the post should be hidden or not.

Response

Status: 204 No Content

Errors

Status code Error reason
404 Post with provided guid could not be found
409 Post is already hidden
410 Post is not hidden
422 Request invalid

Vote on poll

Record a vote on a poll embedded into a post.

POST /api/v1/posts/:post_guid/vote
{
  "poll_answer": 3
}

Parameters

Name Type Description
poll_answer integer The id of the answer for which the vote should be recorded for.

Response

Status: 204 No Content

Errors

Status code Error reason
404 Post with provided guid could not be found
410 There already was a vote recorded for this poll
422 The request was invalid, such as a wrong id given