Skip to main content
PUT
/
api
/
v3
/
network-settings
/
social
Update social configuration.
curl --request PUT \
  --url https://apix.us.amity.co/api/v3/network-settings/social \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "userPrivacySetting": "public",
  "isFollowWithRequestEnabled": false,
  "isAllowEditPostWhenReviewingEnabled": true,
  "showOnlyMyFeed": false,
  "showMyPost": true,
  "showEveryonePost": true,
  "showCommunityPost": true,
  "showFollowingPost": true,
  "isAllowMentionedChannelEnabled": true,
  "disallowNonMemberInteractInCommunity": true,
  "storyExpiryTimeMinutes": 1440,
  "allowAllUserToCreateStory": true,
  "allowJoinPrivateCommunity": true,
  "maxGlobalPinnedPost": 1
}'
{
  "enabled": true,
  "userPrivacySetting": "public",
  "membershipAcceptance": "automatic",
  "isFollowWithRequestEnabled": false,
  "isAllowEditPostWhenReviewingEnabled": true,
  "disallowNonMemberInteractInCommunity": true,
  "allowJoinPrivateCommunity": false,
  "globalFeed": {
    "showOnlyMyFeed": false,
    "showMyPost": true,
    "showEveryonePost": true,
    "showCommunityPost": true,
    "showFollowingPost": true,
    "maxGlobalPinnedPost": 123
  },
  "story": {
    "expiryTimeMinutes": 720,
    "allowAllUserToCreateStory": false
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

information for a network setting

userPrivacySetting
enum<string>
Available options:
public,
private
isFollowWithRequestEnabled
boolean
default:false
isAllowEditPostWhenReviewingEnabled
boolean
showOnlyMyFeed
boolean
default:false
showMyPost
boolean
showEveryonePost
boolean
showCommunityPost
boolean
showFollowingPost
boolean
isAllowMentionedChannelEnabled
boolean
disallowNonMemberInteractInCommunity
boolean
storyExpiryTimeMinutes
integer
default:1440
Required range: 60 <= x <= 1440
allowAllUserToCreateStory
boolean

Allow all user to create story (default will allow only user that have permission to create story)

allowJoinPrivateCommunity
boolean
deprecated

Controls whether users can join private communities directly or need to be added by moderators.

  • true - Allow users to join private communities by themselves
  • false - Users need to be added to join private communities

⚠️ DEPRECATED NOTICE

Community moderators are now be able to respond whether to allow users to become members of private communities.

maxGlobalPinnedPost
integer
default:1

Maximum number of global pinned post (only super admin)

Required range: 1 <= x <= 20

Response

Social configuration

enabled
boolean
userPrivacySetting
enum<string>
Available options:
public,
private
membershipAcceptance
enum<string>
default:automatic

Controls how users can join the network

Available options:
invitation,
automatic
isFollowWithRequestEnabled
boolean
default:false
isAllowEditPostWhenReviewingEnabled
boolean
disallowNonMemberInteractInCommunity
boolean
allowJoinPrivateCommunity
boolean
default:false
globalFeed
object
story
object