Privacy buckets
Privacy buckets control which data an account shares with particular friends.
Object schema
Fields returned by Get privacy bucket. Individual endpoint pages document their complete response shapes.
| Name | Type | Required | Description |
|---|---|---|---|
_id | string | Required | Unique identifier. |
name | string | Required | Name of the resource. |
description | string | Optional | Description of the resource. |
icon | string | Optional | Icon. |
iconColorPreset | string | Optional | Icon Color Preset. |
slug | string | Required | Slug. |
friendPermissions | object | Required | Friend Permissions. |
friendPermissions.members_view | string | Required | Members_view. Allowed values: "none", "read", "read_write". |
friendPermissions.member_profile | string | Required | Member_profile. Allowed values: "none", "read", "read_write". |
friendPermissions.member_avatar | string | Required | Member_avatar. Allowed values: "none", "read", "read_write". |
friendPermissions.member_notes | string | Required | Member_notes. Allowed values: "none", "read", "read_write". |
friendPermissions.member_custom_fields | string | Required | Member_custom_fields. Allowed values: "none", "read", "read_write". |
friendPermissions.member_statuses | string | Required | Member_statuses. Allowed values: "none", "read", "read_write". |
friendPermissions.member_relationships | string | Required | Member_relationships. Allowed values: "none", "read", "read_write". |
friendPermissions.groups | string | Required | Groups. Allowed values: "none", "read", "read_write". |
friendPermissions.front | string | Required | Front. Allowed values: "none", "read", "read_write". |
friendPermissions.front_history | string | Required | Front_history. Allowed values: "none", "read", "read_write". |
friendPermissions.friend_data | string | Required | Friend_data. Allowed values: "none", "read", "read_write". |
createdAt | number | Required | Creation time. |
updatedAt | number | Required | Most recent update time. |
Endpoints
30 operations
GETList directories for bucket
/api/v1/privacy-buckets/{bucketId}/directoriesGETList groups for bucket/api/v1/privacy-buckets/{bucketId}/groupsGETList members for bucket/api/v1/privacy-buckets/{bucketId}/membersGETGet privacy bucket/api/v1/privacy-buckets/{bucketId}PATCHUpdate privacy bucket/api/v1/privacy-buckets/{bucketId}DELETEDelete privacy bucket/api/v1/privacy-buckets/{bucketId}GETGet custom field bucket assignments/api/v1/privacy-buckets/assignments/custom-fields/{fieldDefinitionId}PUTSet custom field bucket assignments/api/v1/privacy-buckets/assignments/custom-fields/{fieldDefinitionId}GETGet directory bucket assignments/api/v1/privacy-buckets/assignments/directories/{directoryId}PUTSet directory bucket assignments/api/v1/privacy-buckets/assignments/directories/{directoryId}GETGet friend bucket assignments/api/v1/privacy-buckets/assignments/friends/{friendUserId}PUTSet friend bucket assignments/api/v1/privacy-buckets/assignments/friends/{friendUserId}GETGet group bucket assignments/api/v1/privacy-buckets/assignments/groups/{groupId}PUTSet group bucket assignments/api/v1/privacy-buckets/assignments/groups/{groupId}GETGet member bucket assignments/api/v1/privacy-buckets/assignments/members/{memberId}PUTSet member bucket assignments/api/v1/privacy-buckets/assignments/members/{memberId}GETGet profile section bucket assignments/api/v1/privacy-buckets/assignments/profile-sections/{memberId}/{sectionKey}PUTSet profile section bucket assignments/api/v1/privacy-buckets/assignments/profile-sections/{memberId}/{sectionKey}GETGet side system bucket assignments/api/v1/privacy-buckets/assignments/side-systems/{sideSystemId}PUTSet side system bucket assignments/api/v1/privacy-buckets/assignments/side-systems/{sideSystemId}GETGet sub system bucket assignments/api/v1/privacy-buckets/assignments/sub-systems/{subSystemId}PUTSet sub system bucket assignments/api/v1/privacy-buckets/assignments/sub-systems/{subSystemId}POSTBulk adjust directory bucket membership/api/v1/privacy-buckets/bulk/directoriesPOSTBulk adjust friend bucket membership/api/v1/privacy-buckets/bulk/friendsPOSTBulk adjust group bucket membership/api/v1/privacy-buckets/bulk/groupsPOSTBulk adjust member bucket membership/api/v1/privacy-buckets/bulk/membersGETGet default buckets/api/v1/privacy-buckets/defaults/{kind}PUTSet default buckets/api/v1/privacy-buckets/defaults/{kind}GETList privacy buckets/api/v1/privacy-bucketsPOSTCreate privacy bucket/api/v1/privacy-buckets