Loading ...

REST API: Create Wall Post | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Wall Posts » REST API: Create Wall Post
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 9

REST API: Create Wall Post

0 
 /5
0 (0votes)

Create new wall post

POST /api/wall

Saves a new wall post object in the Communifire database. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Wall Post JSON Used in the request body This is JSON that represents a wall post object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
WallText Used in the request body Text to be added as wall post.
Optional Parameters How to use Description
ToUserID Used in the request body ID of the user on whose wall you want to add the wall post.
SpaceID Used in the request body ID of the space in which you want to add a wall post
SharedLinkTitle Used in the request body Use shared properties when you want to share any external content within the community. This is the title of that shared content.
SharedLinkDescription Used in the request body The description of shared content.
SharedLinkHref Used in the request body
 Link of the shared content.
SharedLinkImageSrc Used in the request body
 Featured image of the shared content.

Example URL to POST: http://your-community.com/api/wall

Request JSON sample for adding a new wall post


{
    "WallText": "We'd love everyone's thoughts and opinions.",
    "SharedLinkTitle": "Everyone started small",
    "SharedLinkDescription": "Learn how you can build your business...",
    "SharedLinkImageSrc": "https://your-site.com/business.jpg",
    "SharedLinkHref": "https://your-site.com/learn-to-build"
}

Response JSON sample where Wall Post ID is returned as ResponseData


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":251
}


Please Note Your content type that you pass in the header of your request should be 'application/json'.

 

Wiki Index

Pages

Intranet Software