跳到导航

更新成员

更新工作区成员属性。除邮箱标识符外,未指定的参数将保持不变。仅工作区管理员可以调用此端点。

请求头

xi-api-keystring可选

请求

This endpoint expects an object.
emailstring必需

目标用户的邮箱。

is_lockedboolean or null可选

是否锁定或解锁用户账户。

workspace_seat_typeenum or null可选

工作区席位类型。

允许的值:
allow_downgrade_to_basic_seatboolean可选默认为 false

解锁用户时,若其原始席位类型已无可用席位但仍有基础席位可用,则将该用户降级为基础席位,而不是操作失败。

workspace_roleenum or null可选Deprecated

用户的工作区角色。此字段已弃用,请改用 workspace_seat_type。

允许的值:

响应

成功响应

statusstring

更新工作区成员请求的状态。如果请求成功,状态将为 ‘ok’。否则将返回状态为 500 的错误消息。

错误

422
Unprocessable Entity Error