Posts

Add a new post

Add a new post.

Required scopes: flex.collaboration.posts.create

post/api/v2/organizations/{orgSlug}/posts

Request

  • Base URL
    https://app.officernd.com
  • URL
    https://app.officernd.com/api/v2/organizations/{orgSlug}/posts
  • Auth
    OAuth 2
    Authorization code: https://identity.officernd.com/auth/authorize
    Client credentials
    Token URL: https://identity.officernd.com/auth/token scopes: flex.collaboration.posts.create

Path parameters

orgSlugstring required

organization slug

Request body

titlestring required

The title of the post.

descriptionstring required

The content of the post.

locationsstring[] required

An array with the ids of all locations in which the post is visible.

isPinnedboolean

Shows if the post is pinned to the top.

type'info' | 'important' | 'event'

The type of the post.

urlstring

An additional url that is shown in the post.

imagestring

The url of the image of the post.

memberstring

The _id of the member that created the post.

companystring

The _id of the company that created the post.

Example request

{
  "locations": []
}

Response

_idstring

The _id of the post.

titlestring

The title of the post.

descriptionstring

The content the post.

locationsstring[]

An array with the ids of all locations in which the post is visible.

isPinnedboolean

Shows if the post is pinned to the top.

type'info' | 'important' | 'event'

The type of the post.

urlstring

An additional url that is shown in the post.

imagestring

The url of the image of the post.

memberstring

The _id of the member that created the post.

companystring

The _id of the company that created the post.

createdBystring

The user that created the post.

createdAtstring

The time when the post was created.

Changes

No recorded changes to this operation across all 1 revision of this API.