REST API: Set Profile Field Visibility

Grace Kamau

Published: 7/8/2021

Grace Kamau

Updated: 7/8/2021

0 (0votes)

Set Profile Field Visibility

Sets the visibility of a profile field for a specific user. Valid for Communifire version 8.0 and above.

HTTP Method

POST

Response Format

JSON

Requires Authentication?

YES

Product Version

8.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.
ContentID	&ContentID=x - Used in the request URL as a query parameter	The user ID of the user.
FieldUseID	&FieldUseID=x - Used in the request URL as a query parameter	The ID of the profile field.
Visibility	&Visibility=x - Used in the request URL as a query parameter	Public = 0 Community (Intranet users) = 1 Private = 2

True/false indicator is returned as ResponseData.

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

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