API DocsAPI Docs
put/api/group/{groupId}
put/api/group/{groupId}
更新小组信息
Basic Information
Request Method:
put
Request URL:
https://www.lycoo.com/api/group/{groupId}
Tags:
小组基本信息
Description
更新指定小组的基本信息。只有小组创建者可以更新小组信息。
用途:
- 修改小组名称、描述、公开性等基本信息
- 只有小组创建者可以执行此操作
Path Parameters
Path Parameters Explanation
Path parameters are variables in the URL path, for example:
https://www.lycoo.com/api/group/:groupId
Parameter Name | Type | Required | Example Value | Description |
---|---|---|---|---|
groupId | string | Required | example | 要更新的小组ID |
Header Parameters
Header Parameters Explanation
Header parameters are used to pass additional information, such as authentication credentials, content type, etc.
Parameter Name | Type | Required | Example Value | Description |
---|---|---|---|---|
Authorization | string | Required | Bearer sha_1234567890abcdef... | The authentication header is used to verify the identity of API requests, containing an access token Format: Bearer {token} |
Request Body Parameters
Request Body Parameters Explanation
Request body parameters are used to pass complex structured data, typically using the following format: application/json
Parameter Details
Parameter Name | Type | Required | Example Value | Description |
---|---|---|---|---|
name | string | Optional | 张三 | 小组名称 |
description | string | Optional | example | 小组描述 |
isPublic | boolean | Optional | true | 是否公开 |
JSON Example
{
"name": "我的小组",
"description": "这是一个测试小组",
"isPublic": true
}
Response Example
200小组信息更新成功
{
"success": true,
"message": "string"
}
401
403
404
500