Skip to main content

Create post​

Create a new post

Request Body required
    post object required
    roomPostStatus number required

    Possible values: [0, 1, 2]

    The room post status, defaults to publicly: 1. As Room: 0, Publicly: 1, Only Members: 2

    body string required

    Possible values: >= 6 characters

    draft boolean required
    references object[] required
  • Array [
    • chapterId number required

    Possible values: >= 1

    from number required

    Default value: 0

    to number required

    Default value: 0

  • ]
    • mentions object[] required
  • Array [
    • marker string required

    Possible values: Value must match regular expression /{{[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}}}/

    userId string required
    displayName string required
  • ]
    • roomId number required
    postAsAuthorId string required
    publishedAt date-time required
Responses

Post created successfully

Schema
    post object required
    tags object[]
  • Array [
    • language string
    id number required
    name string
  • ]
    • references object[]
  • Array [
    • id string required
    from number
    to number
    chapterId number
  • ]
    • author object
    recentComment object
    id number required
    author object required
    postsCount number
    avatarUrls object required
    small string
    medium string
    large string
    id string required
    username string
    verified boolean

    Default value: false

    firstName string
    lastName string
    memberType number
    body string required
    createdAt date-time required
    room object nullable
    isAdmin object
    isOwner object
    isPublic object
    id number required
    subdomain string
    roomType string
    verified boolean

    Default value: false

    name string
    _group string
    mentions object[]
  • Array [
    • postsCount number
    avatarUrls object required
    small string
    medium string
    large string
    id string required
    username string
    verified boolean

    Default value: false

    firstName string
    lastName string
    memberType number
    locations object required
    followersCount number required
    displayName string
  • ]
    • isLiked boolean
    isByFollowedUser boolean
    isCommentedOn boolean
    isSaved boolean
    id number required
    authorId string required
    body string
    discussionId number
    draft boolean

    Default value: false

    createdAt date-time required
    updatedAt date-time required
    publishedAt date-time
    global boolean
    toxicityScore number
    reported boolean

    Default value: false

    views number
    removed boolean

    Default value: false

    verified boolean

    Default value: false

    roomPostStatus number

    Possible values: [0, 1, 2]

    Default value: 0

    @description 0: OnlyMembers, 1: Publicly, 2: AsRoom

    hidden boolean

    Default value: false

    commentsCount number required

    Default value: 0

    likesCount number

    Default value: 0

    viewsCount number

    Default value: 0

    languageId number
    languageName string
    moderationStatus number

    Possible values: [1, 2, 3, 4, 5, 6, 30]

    featured = 1, // Like Sticky posts, will be featured for a time period.Shown at top in feed and partner apps

    promoted = 2, // High quality content.Shown at top(after featured) in feed and partner apps

    normal = 3, // Default status, available in search, latest and popular tabs.In feed(if you're following the author)

    hidden = 4, // Visible only to author or moderators, or via private share link.

    private_note = 5, // Private notes, only visible to author or via private share link.These are the posts made "private" by moderators.

    requested_review = 6, // User requested the review, treat them has hidden.Only visible to author and moderators

    deleted = 30,

    reviewedAt date-time
    featuredAt date-time
    estimatedReadingTime number

    Default value: 0

    roomId number required
    postTypeId number required
    postTypeName string
    success boolean required
Loading...