REST API: Feature User

Grace Kamau

Published: 9/25/2020

0 (0votes)

Feature User

Feature or unfeature a user. Valid for Communifire version 6.0 and above.

HTTP Method

PUT

Response Format

JSON

Requires Authentication?

YES

Product Version

6.0 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.
UserID	&UserID=x - Used in the request URL as a query parameter	Unique ID of the user to feature or unfeature.
IsFeatured	&IsFeatured=x - Used in the request URL as a query parameter	Set as true or false.

True/false is returned as ResponseData.

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

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