Skip to main content

Modify Group Information

Brief Description

  • Modify group information. Only pass the fields that need to be modified, zero value is also supported.

Request Method

  • post

Request URL

  • {API_ADDRESS}/group/set_group_info_ex
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global link tracking, timestamp is recommended, independent in each request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameter Example

{
"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
groupIDRequiredstringGroup ID to be modified
groupNameOptionalstringNew group name
notificationOptionalstringNew group notification
introductionOptionalstringNew group introduction
faceURLOptionalstringNew group avatar
exOptionalstringNew group extended field
needVerificationOptionalintDo joining the group need verification; 0: Applying to join the group needs to be agreed, member invitation can directly join the group, 1: Everyone joining the group needs verification, except group owner and admin inviting to join the group, 2: Directly join the group
lookMemberInfoOptionalintCan other group member's information be viewed; 0: Allowed to view group member information, 1: Not allowed to view group member information
applyMemberFriendOptionalintCan group members add friends; 0: Allowed to add friends from group members, 1: Not allowed to add

Success Return Example

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

Parameter Description for Success Return Example

Parameter NameTypeDescription
errCodeintError code, 0 means successful
errMsgstringBrief error message, empty
errDlterrDltDetailed error message, empty
dataobjectGeneric data object, specific structure is below

Failure Return Example

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

Parameter Description for Failure Return Example

Parameter NameTypeDescription
errCodeintError code, specifically check the global error code document
errMsgstringBrief error message
errDlterrDltDetailed error message