REST API: Change User Forum Subscription

Vivek Thakur

Published: 3/31/2011

Grace Kamau

Updated: 3/30/2021

0 (0votes)

Change User Forum Subscription

Subscribe or unsubscribe a user from a forum. Valid for Communifire version 5.2 and above.

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.
EntityType	&EntityType=x - Used in the request URL as a query parameter	Entity Type for forum is 1.
ContentID	&ContentID=x - Used in the request URL as a query parameter	Unique identifier for a particular forum.
UserID	&UserID=x - Used in the request URL as a query parameter	ID of the user whose subscription needs to be changed.
IsSubscribe	Used in request body	Specifies if the forum is subscribed by the user. Accepted values: true false

Body:

"true"

True/false is returned as ResponseData.

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

Please Note Pass application/json as the content type in the header of your request.