Update person privacy settings

put

https://{tenant}.onechurchsoftware.com/api/people/{id}/privacy

Update who may see each part of the given person's profile. Each field takes a visibility level id. First retrieve the current settings from /api/people/{id}/privacy, apply your changes, then send back the full object.

Required permission: Full Write People

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the person.

Body Params

The privacy settings.

visibility

object | null

Whether the person is listed in the directory at all (visibility level id and name).

gender

object | null

Who may see the person's gender (visibility level id and name).

birthday

object | null

Who may see the person's birthday (visibility level id and name).

age

object | null

Who may see the person's age (visibility level id and name).

maritalStatus

object | null

Who may see the person's marital status (visibility level id and name).

anniversary

object | null

Who may see the person's anniversary (visibility level id and name).

race

object | null

Who may see the person's race (visibility level id and name).

ethnicity

object | null

Who may see the person's ethnicity (visibility level id and name).

language

object | null

Who may see the person's language (visibility level id and name).

occupation

object | null

Who may see the person's occupation (visibility level id and name).

object | null

Who may see the person's email address (visibility level id and name).

phone

object | null

Who may see the person's phone number (visibility level id and name).

address

object | null

Who may see the person's address (visibility level id and name).

social

object | null

Who may see the person's social network links (visibility level id and name).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK

404Not Found