SiteGPT

更新白标用户

开发环境

PATCH

/api/v0/w/brands/{brandId}/users/{userId}

更新您的白标品牌的用户。

先决条件：

您必须是 SiteGPT 中的白标客户。

您需要在 SiteGPT 仪表板中创建和配置您自己的品牌。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'http://dev-cn.your-api-server.com/api/v0/w/brands//users/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "chatbotsQuota": 1,
  "linksQuota": 100,
  "filesQuota": 25,
  "combinedMessagesQuota": 250,
  "membersQuota": 2
}'

响应示例

200 - 成功示例

{
  "success": true,
  "message": "Updated the whitelabel user of the brand successfully",
  "data": {
    "whitelabelUser": {
      "id": "332153612345906321",
      "brandId": "332110515123458123",
      "email": "user@example.com",
      "name": "",
      "profilePic": "",
      "chatbotsQuota": 2,
      "linksQuota": 20,
      "filesQuota": 5,
      "combinedMessagesQuota": 25,
      "membersQuota": 2,
      "createdAt": "2024-02-05T13:35:44.155845Z",
      "updatedAt": "2024-02-05T13:35:44.155845Z"
    }
  }
}

请求参数

Path 参数

brandId

string

必需

需要更新配额的白标用户id

userId

string

必需

白标品牌的 ID

Header 参数

Authorization

string

必需

示例值:

Bearer <token>

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

chatbotsQuota

integer

可选

分配给用户的聊天机器人配额

linksQuota

integer

可选

分配给用户的链接配额

filesQuota

integer

可选

分配给用户的文件配额

combinedMessagesQuota

integer

可选

分配给用户的合并消息配额

membersQuota

integer

可选

分配给用户的成员配额

示例

返回响应

🟢200成功

application/json

Body

success

boolean

必需

message

string

必需

data

object

必需

whitelabelUser

object

必需

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🔴500服务器错误

修改于 2024-03-28 08:41:09

添加白标用户