REST API: Set Multiple Profile Fields Visibility

JD Flores

Published: 3/25/2022

JD Flores

Updated: 3/25/2022

0 (0votes)

Set Multiple Profile Fields Visibility

Sets the visibility of multiple profile fields in a single API call. 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=376 is placed in the request URL	This ID tells the API call it is sending multiple fields to update.
FieldUseID	Used in the request Body as a parameter	The ID of the profile field. OR This can also be the field label (i.e. "Phone", "SlackId")
Visibility	Used in the request Body as a parameter	Public = 0 Community (Intranet users) = 1 Private = 2

Body option 1 example template: "{\"FieldUseID\":\"Visibility\",\"FieldUseID\":\"Visibility\"}"

"{\"67\":\"2\",\"180\":\"2\"}"

Body option 2 example template: "{\"FieldLabel\":\"Visibility\",\"FieldLabel\":\"Visibility\"}"

"{\"slack\":\"2\",\"phone\":\"2\"}"

Note: Stringify your JSON data.

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.