Skip to main content

set_group_info_EX

Brief description

Request method

  • post

Request URL

  • {API_ADDRESS}/group/set_group_info
header nameexample valueoptionaltypedescription
operationID1646445464564requiredstringoperationID is used for global link tracking
tokeneyJhbxxxx3XsrequiredstringAdministrator token

Request parameter example

{
"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.groupIDRequiredstringGroup ID to be modified
groupInfoForSet.groupNameOptionalstringNew group name
groupInfoForSet.notificationOptionalstringNew group notification
groupInfoForSet.introductionOptionalstringNew group introduction
groupInfoForSet.faceURLOptionalstringNew group avatar
groupInfoForSet.exOptionalstringNew group extended field
groupInfoForSet.needVerificationOptionalintWhether verification is required to join the group; 0: requires approval for joining, members can directly join by invitation, 1: everyone needs verification to join except for group owner and administrators, 2: direct joining
groupInfoForSet.lookMemberInfoOptionalintWhether to allow viewing other group members' information; 0: allows viewing group members' information, 1: does not allow viewing group members' information
groupInfoForSet.applyMemberFriendOptionalintWhether group members can add friends; 0: allows adding friends from group members, 1: does not allow adding

Successful Response Example

{
"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