Skip to main content

set_group_info

Brief Description

  • Modify the group information. (This interface is deprecated, it is recommended to use set_group_info_ex)

Request Method

  • post

Request URL

  • {API_ADDRESS}/group/set_group_info
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringoperationID for global link tracking
tokeneyJhbxxxx3XsRequiredstringAdministrator token

Sample Request Parameters

{
"groupInfoForSet": {
"groupID": "xadxwr24",
"groupName": "new name",
"notification": "new notification",
"introduction": "new introduction",
"faceURL": "www.newfaceURL.com",
"ex": "new ex",
"needVerification": 1,
"lookMemberInfo": 1,
"applyMemberFriend": 1
}
}
Field NameOptionalTypeDescription
groupInfoForSetRequiredobjectGroup information object
groupInfoForSet.groupIDRequiredstringID of the group to be modified
groupInfoForSet.groupNameOptionalstringNew group name
groupInfoForSet.notificationOptionalstringNew group announcement
groupInfoForSet.introductionOptionalstringNew group introduction
groupInfoForSet.faceURLOptionalstringNew group avatar
groupInfoForSet.exOptionalstringNew group extended field
groupInfoForSet.needVerificationOptionalintWhether verification is needed to join the group; 0: Group join requests require approval, members can be invited directly; 1: Everyone requires verification to join, except for invitations by group owner or admin; 2: Join directly
groupInfoForSet.lookMemberInfoOptionalintPermission to view other group members' information; 0: Allowed to view group members' information, 1: Not allowed to view
groupInfoForSet.applyMemberFriendOptionalintPermission for group members to add friends; 0: Allowed to add friends from group members, 1: Not allowed

Sample Success Response

{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}

Parameters Explanation for Success Response

Parameter NameTypeDescription
errCodeintError code, 0 means success
errMsgstringBrief error message, empty if no error
errDlterrDltDetailed error message, empty if no error
dataobjectGeneral data object, see detailed structure below

Sample Failure Response

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

Parameters Explanation for Failure Response

Parameter NameTypeDescription
errCodeintError code, see global error code documentation for details
errMsgstringBrief error message
errDlterrDltDetailed error message