Loading ...

REST API: Approve/Decline Space User | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Spaces » REST API: Approve/Decline Space User
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 12

REST API: Approve/Decline Space User

0 
 /5
0 (0votes)

Approve/decline space user

PUT /api/spaces/{spaceid}/users/{userid}/membership/status

Users need approval to join moderated spaces. This join request goes to the space admin; who can approve or decline the request. This can be done by passing "true/false" in the request body for approving/declining user's space join request. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
PUT
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.
SpaceID Used in the request URL (see below) ID of the space which the user wants to join.
UserID Used in the request URL (see below) ID of the user who wants to join space.
Value Used in the request body Pass "true" to approve or "false" to decline.

Example URL to PUT: https://your-community.com/api/spaces/240/users/1350/membership/status

Request JSON sample for approving the user request


true

Response JSON sample where indicator (true/false) is returned as ResponseData


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

Please Note ResponseData "true" represents the success of the desired action (approve or decline).

 

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

Wiki Index

Pages

Intranet Software